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