libcaptive-gnomevfs.so separated to Gnome-VFS vs. reactos specific parts
[captive.git] / src / libcaptive / client / directory.c
diff --git a/src/libcaptive/client/directory.c b/src/libcaptive/client/directory.c
new file mode 100644 (file)
index 0000000..41ed664
--- /dev/null
@@ -0,0 +1,298 @@
+/* $Id$
+ * captive vfs 'directory' interface to reactos
+ * Copyright (C) 2002-2003 Jan Kratochvil <project-captive@jankratochvil.net>
+ * 
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; exactly version 2 of June 1991 is required
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+
+#include "config.h"
+
+#include "captive/client-directory.h"  /* self */
+#include "lib.h"
+#include <glib/gmessages.h>
+#include "captive/unicode.h"
+#include "reactos/ntos/types.h"        /* for HANDLE */
+#include "reactos/ddk/iotypes.h"       /* for IO_STATUS_BLOCK */
+#include "reactos/ddk/iofuncs.h"       /* for IoCreateFile() */
+
+
+static gpointer captive_directory_object_parent_class=NULL;
+
+
+static GnomeVFSResult captive_directory_close(CaptiveDirectoryObject *captive_directory_object);
+
+static void captive_directory_object_finalize(CaptiveDirectoryObject *captive_directory_object)
+{
+GnomeVFSResult errvfsresult;
+
+       g_return_if_fail(captive_directory_object!=NULL);
+
+       errvfsresult=captive_directory_close(captive_directory_object);
+       g_assert(errvfsresult==GNOME_VFS_OK);
+
+       G_OBJECT_CLASS(captive_directory_object_parent_class)->finalize((GObject *)captive_directory_object);
+}
+
+
+static void captive_directory_object_class_init(CaptiveDirectoryObjectClass *class)
+{
+GObjectClass *gobject_class=G_OBJECT_CLASS(class);
+
+       captive_directory_object_parent_class=g_type_class_ref(G_TYPE_OBJECT);
+       gobject_class->finalize=(void (*)(GObject *object))captive_directory_object_finalize;
+}
+
+
+static void captive_directory_object_init(CaptiveDirectoryObject *captive_directory_object)
+{
+       captive_directory_object->dir_Handle=NULL;
+       captive_directory_object->read_first=TRUE;
+}
+
+
+GType captive_directory_object_get_type(void)
+{
+static GType captive_directory_object_type=0;
+
+       if (!captive_directory_object_type) {
+static const GTypeInfo captive_directory_object_info={
+                               sizeof(CaptiveDirectoryObjectClass),
+                               NULL,   /* base_init */
+                               NULL,   /* base_finalize */
+                               (GClassInitFunc)captive_directory_object_class_init,
+                               NULL,   /* class_finalize */
+                               NULL,   /* class_data */
+                               sizeof(CaptiveDirectoryObject),
+                               5,      /* n_preallocs */
+                               (GInstanceInitFunc)captive_directory_object_init,
+                               };
+
+               captive_directory_object_type=g_type_register_static(G_TYPE_OBJECT,
+                               "CaptiveDirectoryObject",&captive_directory_object_info,0);
+               }
+
+       return captive_directory_object_type;
+}
+
+
+GnomeVFSResult captive_directory_new_open(CaptiveDirectoryObject **captive_directory_object_return,const gchar *pathname)
+{
+GnomeVFSResult errvfsresult;
+OBJECT_ATTRIBUTES dir_ObjectAttributes;
+HANDLE dir_Handle;
+IO_STATUS_BLOCK dir_IoStatusBlock;
+NTSTATUS err;
+CaptiveDirectoryObject *captive_directory_object;
+
+       if (CAPTIVE_IS_SANDBOX_PARENT())
+               return captive_sandbox_parent_directory_new_open(captive_directory_object_return,pathname);
+
+       g_return_val_if_fail(captive_directory_object_return!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
+       g_return_val_if_fail(pathname!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
+
+       *captive_directory_object_return=NULL;
+
+       errvfsresult=captive_ObjectAttributes_init(pathname,&dir_ObjectAttributes);
+       g_return_val_if_fail(errvfsresult==GNOME_VFS_OK,errvfsresult);
+       
+       /* wanted: * IoCreateFile()->ObCreateObject(,,,IoFileObjectType)->
+        * ->(IoFileObjectType->Create==IopCreateFile)()->IoMountVolume()
+        */
+       err=IoCreateFile(
+                       &dir_Handle,    /* FileHandle */
+                       FILE_LIST_DIRECTORY,    /* DesiredAccess */
+                       &dir_ObjectAttributes,  /* ObjectAttributes */
+                       &dir_IoStatusBlock,     /* IoStatusBlock */
+                       NULL,   /* AllocationSize; ignored for open */
+                       FILE_ATTRIBUTE_NORMAL,  /* FileAttributes; ignored for open */
+                       FILE_SHARE_WRITE,       /* ShareAccess; 0 means exclusive */
+                       FILE_OPEN,      /* CreateDisposition */
+                       /* FILE_SYNCHRONOUS_IO_{,NON}ALERT: We need to allow W32 filesystem
+                        * any waits to not to let it return STATUS_CANT_WAIT us.
+                        * Alertability should have only effect on asynchronous events
+                        * from KeWaitForSingleObject() by setting/clearing its parameter 'Alertable'.
+                        */
+                       FILE_DIRECTORY_FILE|FILE_SYNCHRONOUS_IO_ALERT,  /* CreateOptions */
+                       NULL,   /* EaBuffer */
+                       0,      /* EaLength */
+                       CreateFileTypeNone,     /* CreateFileType */
+                       NULL,   /* ExtraCreateParameters */
+                       0);     /* Options */
+       g_free(dir_ObjectAttributes.ObjectName);        /* left from captive_gnomevfs_uri_parent_init() */
+       g_return_val_if_fail(NT_SUCCESS(err)==NT_SUCCESS(dir_IoStatusBlock.Status),GNOME_VFS_ERROR_GENERIC);
+       g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
+       g_return_val_if_fail(dir_IoStatusBlock.Information==FILE_OPENED,GNOME_VFS_ERROR_GENERIC);
+
+       captive_directory_object=g_object_new(
+                       CAPTIVE_DIRECTORY_TYPE_OBJECT,  /* object_type */
+                       NULL);  /* first_property_name; FIXME: support properties */
+
+       captive_directory_object->dir_Handle=dir_Handle;
+
+       *captive_directory_object_return=captive_directory_object;
+       return GNOME_VFS_OK;
+}
+
+
+static GnomeVFSResult FileIdBothDirInformation_to_GnomeVFSFileInfo(GnomeVFSFileInfo *file_info,
+               FILE_ID_BOTH_DIR_INFORMATION *FileIdBothDirInformation,IO_STATUS_BLOCK *IoStatusBlock)
+{
+UNICODE_STRING FileName_UnicodeString;
+BOOLEAN errBOOLEAN;
+ULONG tmp_ULONG;
+
+       g_return_val_if_fail(file_info!=NULL,GNOME_VFS_ERROR_GENERIC);
+       g_return_val_if_fail(FileIdBothDirInformation!=NULL,GNOME_VFS_ERROR_GENERIC);
+
+       g_return_val_if_fail(NT_SUCCESS(IoStatusBlock->Status),GNOME_VFS_ERROR_GENERIC);
+       /* do not exceed the returned buffer by this record;
+        * '->NextEntryOffset' is ==0 as we used 'ReturnSingleEntry==TRUE'
+        */
+       g_assert((gpointer)(((char *)FileIdBothDirInformation)+FileIdBothDirInformation->NextEntryOffset)
+                       <=(gpointer)(((char *)FileIdBothDirInformation)+IoStatusBlock->Information));
+
+       file_info->valid_fields=0;
+
+       FileName_UnicodeString.Length=FileIdBothDirInformation->FileNameLength;
+       FileName_UnicodeString.MaximumLength=FileIdBothDirInformation->FileNameLength
+                       +sizeof(*FileIdBothDirInformation->FileName);   /* 0-terminator */
+       g_assert((gpointer)(((char *)FileIdBothDirInformation->FileName)+FileName_UnicodeString.Length)
+                       <=(gpointer)(((char *)FileIdBothDirInformation)+IoStatusBlock->Information));
+                                       /* ensure we fit below '->IoStatusBlock->Information' at least without the 0-terminator */
+       FileIdBothDirInformation->FileName[FileIdBothDirInformation->FileNameLength
+                       /sizeof(*FileIdBothDirInformation->FileName)]=0;        /* 0-terminate it */
+       FileName_UnicodeString.Buffer=FileIdBothDirInformation->FileName;
+       file_info->name=captive_UnicodeString_to_utf8_malloc(&FileName_UnicodeString);
+       /* '->name' assumed for 'file_info->valid_fields' */
+
+       /* FIXME: What is 'FILE_ATTRIBUTE_NORMAL'? */
+       switch (FileIdBothDirInformation->FileAttributes & (0
+                       | FILE_ATTRIBUTE_DIRECTORY
+                       | FILE_ATTRIBUTE_DEVICE)) {
+               case 0:                        file_info->type=GNOME_VFS_FILE_TYPE_REGULAR;   break;
+               case FILE_ATTRIBUTE_DIRECTORY: file_info->type=GNOME_VFS_FILE_TYPE_DIRECTORY; break;
+               case FILE_ATTRIBUTE_DEVICE:    file_info->type=GNOME_VFS_FILE_TYPE_SOCKET;
+                       /* or GNOME_VFS_FILE_TYPE_CHARACTER_DEVICE or GNOME_VFS_FILE_TYPE_BLOCK_DEVICE ? */
+                       break;
+               default:                       file_info->type=GNOME_VFS_FILE_TYPE_UNKNOWN;   break;
+               }
+       file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_TYPE;
+
+       /* we use 0600 for r/w files, 0400 for FILE_ATTRIBUTE_READONLY */
+       file_info->permissions=GNOME_VFS_PERM_USER_READ;
+       if (file_info->type==GNOME_VFS_FILE_TYPE_DIRECTORY)
+               file_info->permissions|=GNOME_VFS_PERM_USER_EXEC;
+       if (!(FileIdBothDirInformation->FileAttributes & FILE_ATTRIBUTE_READONLY))
+               file_info->permissions=GNOME_VFS_PERM_USER_WRITE;
+       file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_PERMISSIONS;
+
+       file_info->size=FileIdBothDirInformation->EndOfFile.QuadPart;
+       file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_SIZE;
+
+       file_info->block_count=FileIdBothDirInformation->AllocationSize.QuadPart/512;
+       file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_BLOCK_COUNT;
+
+       file_info->flags=GNOME_VFS_FILE_FLAGS_LOCAL;
+       file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_FLAGS;
+
+       if (FileIdBothDirInformation->LastAccessTime.QuadPart) {        /* it may be 0 if not set */
+               errBOOLEAN=RtlTimeToSecondsSince1970(&FileIdBothDirInformation->LastAccessTime,&tmp_ULONG);
+               g_assert(errBOOLEAN==TRUE);
+               file_info->atime=tmp_ULONG;
+               file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_ATIME;
+               }
+
+       /* it may be 0 if not set */
+       if (FileIdBothDirInformation->LastWriteTime.QuadPart || FileIdBothDirInformation->ChangeTime.QuadPart) {
+               errBOOLEAN=RtlTimeToSecondsSince1970(
+                               /* take the more recent (==bigger) time: */
+                               (FileIdBothDirInformation->LastWriteTime.QuadPart > FileIdBothDirInformation->ChangeTime.QuadPart
+                                               ? &FileIdBothDirInformation->LastWriteTime : &FileIdBothDirInformation->ChangeTime),
+                               &tmp_ULONG);
+               g_assert(errBOOLEAN==TRUE);
+               file_info->mtime=tmp_ULONG;
+               file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_MTIME;
+               }
+
+       if (FileIdBothDirInformation->CreationTime.QuadPart) {  /* it may be 0 if not set */
+               errBOOLEAN=RtlTimeToSecondsSince1970(&FileIdBothDirInformation->CreationTime,&tmp_ULONG);
+               g_assert(errBOOLEAN==TRUE);
+               file_info->ctime=tmp_ULONG;
+               file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_CTIME;
+               }
+
+       return GNOME_VFS_OK;
+}
+
+
+static GnomeVFSResult captive_directory_close(CaptiveDirectoryObject *captive_directory_object)
+{
+NTSTATUS err;
+HANDLE dir_Handle;
+
+       if (CAPTIVE_IS_SANDBOX_PARENT())
+               return captive_sandbox_parent_directory_close(captive_directory_object);
+
+       g_return_val_if_fail(captive_directory_object!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
+       g_return_val_if_fail(captive_directory_object->dir_Handle!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);        /* already closed */
+
+       dir_Handle=captive_directory_object->dir_Handle;
+       captive_directory_object->dir_Handle=NULL;
+       err=NtClose(dir_Handle);
+       g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
+
+       return GNOME_VFS_OK;
+}
+
+
+GnomeVFSResult captive_directory_read(CaptiveDirectoryObject *captive_directory_object,GnomeVFSFileInfo *file_info)
+{
+NTSTATUS err;
+IO_STATUS_BLOCK dir_IoStatusBlock;
+FILE_ID_BOTH_DIR_INFORMATION *FileIdBothDirInformation;
+GnomeVFSResult errvfsresult;
+
+       if (CAPTIVE_IS_SANDBOX_PARENT())
+               return captive_sandbox_parent_directory_read(captive_directory_object,file_info);
+
+       g_return_val_if_fail(captive_directory_object!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
+       g_return_val_if_fail(captive_directory_object->dir_Handle!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
+       g_return_val_if_fail(file_info!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
+
+       FileIdBothDirInformation=(void *)captive_directory_object->QueryDirectory_buf;
+       err=NtQueryDirectoryFile(
+                       captive_directory_object->dir_Handle,   /* FileHandle */
+                       NULL,   /* PEvent; completion signalling; optional */
+                       NULL,   /* ApcRoutine; optional */
+                       NULL,   /* ApcContext; optional */
+                       &dir_IoStatusBlock,     /* IoStatusBlock */
+                       (gpointer)captive_directory_object->QueryDirectory_buf, /* FileInformation */
+                       sizeof(captive_directory_object->QueryDirectory_buf)    /* Length */
+                                       -sizeof(*FileIdBothDirInformation->FileName),   /* reserve space for 0-terminator */
+                       FileIdBothDirectoryInformation, /* FileInformationClass; =>FILE_ID_BOTH_DIR_INFORMATION */
+                       TRUE,   /* ReturnSingleEntry */
+                       NULL,   /* FileName; wildcards possible; optional */
+                       captive_directory_object->read_first);  /* RestartScan */
+       captive_directory_object->read_first=FALSE;
+       if (err==STATUS_NO_MORE_FILES)
+               return GNOME_VFS_ERROR_EOF;
+       g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
+
+       errvfsresult=FileIdBothDirInformation_to_GnomeVFSFileInfo(file_info,FileIdBothDirInformation,
+                       &dir_IoStatusBlock);
+       g_return_val_if_fail(errvfsresult==GNOME_VFS_OK,errvfsresult);
+
+       return GNOME_VFS_OK;
+}