src/libcaptive/client/file.c

   1 /* $Id$
   2  * captive vfs 'file' 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-file.h"        /* self */
  23 #include "file.h"       /* self-priv */
  24 #include "directory.h"
  25 #include "lib.h"
  26 #include <glib/gmessages.h>
  27 #include "captive/unicode.h"
  28 #include "reactos/ntos/types.h" /* for HANDLE */
  29 #include "reactos/ddk/iotypes.h"        /* for IO_STATUS_BLOCK */
  30 #include "reactos/ddk/iofuncs.h"        /* for IoCreateFile() */
  31 #include "result.h"
  32 #include "captive/client-directory.h"
  33 #include "reactos/ddk/obfuncs.h"        /* for ObReferenceObjectByHandle() */
  34 #include "captive/macros.h"
  35 #include "captive/leave.h"
  36 #include "captive/usecount.h"
  37 #include "vfs.h"
  38 #include "captive/parent-File.h"
  39
  40
  41 static gpointer captive_file_object_parent_class=NULL;
  42
  43
  44 static GnomeVFSResult captive_file_close(CaptiveFileObject *captive_file_object);
  45
  46 static void captive_file_object_finalize(CaptiveFileObject *captive_file_object)
  47 {
  48         g_return_if_fail(captive_file_object!=NULL);
  49
  50         captive_file_close(captive_file_object);        /* errors ignored */
  51
  52         G_OBJECT_CLASS(captive_file_object_parent_class)->finalize((GObject *)captive_file_object);
  53 }
  54
  55
  56 static void captive_file_object_class_init(CaptiveFileObjectClass *class)
  57 {
  58 GObjectClass *gobject_class=G_OBJECT_CLASS(class);
  59
  60         captive_file_object_parent_class=g_type_class_ref(G_TYPE_OBJECT);
  61         gobject_class->finalize=(void (*)(GObject *object))captive_file_object_finalize;
  62 }
  63
  64
  65 static void captive_file_object_init(CaptiveFileObject *captive_file_object)
  66 {
  67         captive_file_object->file_Handle=NULL;
  68 }
  69
  70
  71 GType captive_file_object_get_type(void)
  72 {
  73 static GType captive_file_object_type=0;
  74
  75         if (!captive_file_object_type) {
  76 static const GTypeInfo captive_file_object_info={
  77                                 sizeof(CaptiveFileObjectClass),
  78                                 NULL,   /* base_init */
  79                                 NULL,   /* base_finalize */
  80                                 (GClassInitFunc)captive_file_object_class_init,
  81                                 NULL,   /* class_finalize */
  82                                 NULL,   /* class_data */
  83                                 sizeof(CaptiveFileObject),
  84                                 5,      /* n_preallocs */
  85                                 (GInstanceInitFunc)captive_file_object_init,
  86                                 };
  87
  88                 captive_file_object_type=g_type_register_static(G_TYPE_OBJECT,
  89                                 "CaptiveFileObject",&captive_file_object_info,0);
  90                 }
  91
  92         return captive_file_object_type;
  93 }
  94
  95
  96 static GnomeVFSResult captive_file_new_internal(CaptiveFileObject *captive_file_object,
  97                 const gchar *pathname,GnomeVFSOpenMode mode,gboolean create,gboolean create_exclusive,guint create_perm)
  98 {
  99 IO_STATUS_BLOCK file_IoStatusBlock;
 100 GnomeVFSResult errvfsresult;
 101 OBJECT_ATTRIBUTES file_ObjectAttributes;
 102 HANDLE file_Handle;
 103 NTSTATUS err;
 104
 105         g_return_val_if_fail(captive_file_object!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 106         g_return_val_if_fail(pathname!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 107
 108         errvfsresult=captive_ObjectAttributes_init(pathname,&file_ObjectAttributes);
 109         g_return_val_if_fail(errvfsresult==GNOME_VFS_OK,errvfsresult);
 110
 111         /* open */
 112         err=IoCreateFile(
 113                         &file_Handle,   /* FileHandle */
 114                         0
 115                                         |(!(mode&GNOME_VFS_OPEN_READ ) ? 0 : FILE_READ_DATA)
 116                                         |(!(mode&GNOME_VFS_OPEN_WRITE) ? 0 : FILE_WRITE_DATA | FILE_APPEND_DATA | FILE_WRITE_ATTRIBUTES)
 117                                         |(  mode!=0                    ? 0 : FILE_READ_ATTRIBUTES)
 118                                         ,       /* DesiredAccess */
 119                         &file_ObjectAttributes, /* ObjectAttributes */
 120                         &file_IoStatusBlock,    /* IoStatusBlock */
 121                         NULL,   /* AllocationSize; ignored for open */
 122                         (!create || create_perm&0200 ? FILE_ATTRIBUTE_NORMAL: FILE_ATTRIBUTE_READONLY), /* FileAttributes; ignored for open */
 123                         (!create || !create_exclusive   /* ShareAccess; 0 means exclusive */
 124                                         ? (FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE)
 125                                         : 0),
 126                         (!create ? FILE_OPEN : FILE_CREATE),    /* CreateDisposition */
 127                         /* FILE_SYNCHRONOUS_IO_{,NON}ALERT: We need to allow W32 filesystem
 128                                  * any waits to not to let it return STATUS_CANT_WAIT us.
 129                                  * Alertability should have only effect on asynchronous events
 130                                  * from KeWaitForSingleObject() by setting/clearing its parameter 'Alertable'.
 131                                  */
 132                         FILE_SYNCHRONOUS_IO_ALERT,      /* CreateOptions */
 133                         NULL,   /* EaBuffer */
 134                         0,      /* EaLength */
 135                         CreateFileTypeNone,     /* CreateFileType */
 136                         NULL,   /* ExtraCreateParameters */
 137                         0);     /* Options */
 138         g_free(file_ObjectAttributes.ObjectName);       /* left from captive_file_uri_parent_init() */
 139         g_return_val_if_fail(NT_SUCCESS(err)==NT_SUCCESS(file_IoStatusBlock.Status),GNOME_VFS_ERROR_GENERIC);
 140         if (GNOME_VFS_OK!=(errvfsresult=captive_NTSTATUS_to_GnomeVFSResult(err)))
 141                 return errvfsresult;
 142         g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
 143         g_return_val_if_fail(file_IoStatusBlock.Information
 144                                         ==(!create ? FILE_OPENED : FILE_CREATED),
 145                         GNOME_VFS_ERROR_GENERIC);
 146
 147         captive_file_object->file_Handle=file_Handle;
 148
 149         return GNOME_VFS_OK;
 150 }
 151
 152
 153 GnomeVFSResult captive_file_new_open(CaptiveFileObject **captive_file_object_return,
 154                 CaptiveVfsObject *captive_vfs_object,const gchar *pathname,GnomeVFSOpenMode mode)
 155 {
 156 GnomeVFSResult r;
 157 CaptiveFileObject *captive_file_object;
 158
 159         g_return_val_if_fail(captive_file_object_return!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 160         g_return_val_if_fail(captive_vfs_object!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 161         g_return_val_if_fail(pathname!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 162
 163         captive_file_object=g_object_new(
 164                         CAPTIVE_FILE_TYPE_OBJECT,       /* object_type */
 165                         NULL);  /* first_property_name; FIXME: support properties */
 166         captive_file_object->vfs=captive_vfs_object;
 167         captive_file_object->file_Handle=NULL;
 168         captive_file_object->offset=0;
 169         *captive_file_object_return=captive_file_object;
 170
 171         if (captive_vfs_object->is_sandbox_parent)
 172                 return captive_sandbox_parent_file_new_open(captive_file_object,pathname,mode);
 173
 174         r=captive_file_new_internal(captive_file_object,pathname,mode,
 175                         FALSE,  /* create */
 176                         FALSE,  /* create_exclusive; ignored */
 177                         0);     /* create_perm; ignored */
 178
 179         captive_leave();
 180         if (r==GNOME_VFS_OK)
 181                 captive_usecount(+1);
 182         else {
 183                 g_object_unref(captive_file_object);
 184                 *captive_file_object_return=NULL;
 185                 }
 186         return r;
 187 }
 188
 189
 190 GnomeVFSResult captive_file_new_create(CaptiveFileObject **captive_file_object_return,
 191                 CaptiveVfsObject *captive_vfs_object,const gchar *pathname,GnomeVFSOpenMode mode,gboolean exclusive,guint perm)
 192 {
 193 GnomeVFSResult r;
 194 CaptiveFileObject *captive_file_object;
 195
 196         g_return_val_if_fail(captive_file_object_return!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 197         g_return_val_if_fail(captive_vfs_object!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 198         g_return_val_if_fail(pathname!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 199
 200         captive_file_object=g_object_new(
 201                         CAPTIVE_FILE_TYPE_OBJECT,       /* object_type */
 202                         NULL);  /* first_property_name; FIXME: support properties */
 203         captive_file_object->vfs=captive_vfs_object;
 204         captive_file_object->file_Handle=NULL;
 205         captive_file_object->offset=0;
 206         *captive_file_object_return=captive_file_object;
 207
 208         if (captive_vfs_object->is_sandbox_parent)
 209                 return captive_sandbox_parent_file_new_create(captive_file_object,pathname,mode,exclusive,perm);
 210
 211         r=captive_file_new_internal(captive_file_object,pathname,mode,
 212                         TRUE,   /* create */
 213                         exclusive,      /* create_exclusive */
 214                         perm);  /* create_perm */
 215
 216         captive_leave();
 217         if (r==GNOME_VFS_OK)
 218                 captive_usecount(+1);
 219         else {
 220                 g_object_unref(captive_file_object);
 221                 *captive_file_object_return=NULL;
 222                 }
 223         return r;
 224 }
 225
 226
 227 static GnomeVFSResult captive_file_close(CaptiveFileObject *captive_file_object)
 228 {
 229 NTSTATUS err;
 230 HANDLE file_Handle;
 231
 232         g_return_val_if_fail(captive_file_object!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 233
 234         if (captive_file_object->vfs->is_sandbox_parent)
 235                 return captive_sandbox_parent_file_close(captive_file_object);
 236
 237         if (captive_file_object->file_Handle!=NULL) {   /* not yet already closed */
 238                 captive_usecount(-1);   /* close() errors notwithstanding */
 239
 240                 file_Handle=captive_file_object->file_Handle;
 241                 captive_file_object->file_Handle=NULL;
 242                 err=NtClose(file_Handle);
 243                 g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
 244                 }
 245
 246         captive_leave();
 247         return GNOME_VFS_OK;
 248 }
 249
 250
 251 GnomeVFSResult captive_file_read(CaptiveFileObject *captive_file_object,
 252                 gpointer buffer,GnomeVFSFileSize num_bytes,GnomeVFSFileSize *bytes_read_return)
 253 {
 254 NTSTATUS err;
 255 IO_STATUS_BLOCK file_IoStatusBlock;
 256 LARGE_INTEGER file_offset;
 257 GnomeVFSResult errvfsresult;
 258
 259         g_return_val_if_fail(captive_file_object!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 260         g_return_val_if_fail(buffer!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 261         g_return_val_if_fail(bytes_read_return!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 262         g_return_val_if_fail(num_bytes==(ULONG)num_bytes,GNOME_VFS_ERROR_BAD_PARAMETERS);
 263
 264         if (captive_file_object->vfs->is_sandbox_parent)
 265                 return captive_sandbox_parent_file_read(captive_file_object,buffer,num_bytes,bytes_read_return);
 266
 267         g_return_val_if_fail(captive_file_object->file_Handle!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 268
 269         file_offset.QuadPart=captive_file_object->offset;
 270         err=NtReadFile(
 271                         captive_file_object->file_Handle,       /* FileHandle */
 272                         NULL,   /* EventHandle; completion signalling; optional */
 273                         NULL,   /* ApcRoutine; optional */
 274                         NULL,   /* ApcContext; optional */
 275                         &file_IoStatusBlock,    /* IoStatusBlock */
 276                         buffer, /* Buffer */
 277                         num_bytes,      /* Length */
 278                         &file_offset,   /* ByteOffset */
 279                         NULL);  /* Key; NULL means no file locking key */
 280         if (err==STATUS_END_OF_FILE) {
 281                 g_return_val_if_fail(file_IoStatusBlock.Status==STATUS_END_OF_FILE,GNOME_VFS_ERROR_GENERIC);
 282                 g_return_val_if_fail(file_IoStatusBlock.Information==0,GNOME_VFS_ERROR_GENERIC);
 283                 *bytes_read_return=0;
 284                 return GNOME_VFS_ERROR_EOF;
 285                 }
 286         if (GNOME_VFS_OK!=(errvfsresult=captive_NTSTATUS_to_GnomeVFSResult(err)))
 287                 return errvfsresult;
 288         g_return_val_if_fail(NT_SUCCESS(err)==NT_SUCCESS(file_IoStatusBlock.Status),GNOME_VFS_ERROR_GENERIC);
 289         g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
 290         g_return_val_if_fail(file_IoStatusBlock.Information<=num_bytes,GNOME_VFS_ERROR_GENERIC);
 291
 292         captive_file_object->offset+=file_IoStatusBlock.Information;
 293         *bytes_read_return=file_IoStatusBlock.Information;
 294         captive_leave();
 295         return GNOME_VFS_OK;
 296 }
 297
 298
 299 GnomeVFSResult captive_file_write(CaptiveFileObject *captive_file_object,
 300                 gconstpointer buffer,GnomeVFSFileSize num_bytes,GnomeVFSFileSize *bytes_written_return)
 301 {
 302 NTSTATUS err;
 303 IO_STATUS_BLOCK file_IoStatusBlock;
 304 LARGE_INTEGER file_offset;
 305 GnomeVFSFileInfo file_info;
 306 GnomeVFSFileSize endoffile_wanted;
 307 GnomeVFSResult errvfsresult;
 308
 309         g_return_val_if_fail(captive_file_object!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 310         g_return_val_if_fail(buffer!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 311         g_return_val_if_fail(bytes_written_return!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 312         g_return_val_if_fail(num_bytes==(ULONG)num_bytes,GNOME_VFS_ERROR_BAD_PARAMETERS);
 313
 314         if (captive_file_object->vfs->is_sandbox_parent)
 315                 return captive_sandbox_parent_file_write(captive_file_object,buffer,num_bytes,bytes_written_return);
 316
 317         g_return_val_if_fail(captive_file_object->file_Handle!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 318
 319         if ((GnomeVFSFileOffset)(captive_file_object->offset+num_bytes) < captive_file_object->offset)
 320                 return GNOME_VFS_ERROR_TOO_BIG;
 321         endoffile_wanted=captive_file_object->offset+num_bytes;
 322         if (GNOME_VFS_OK!=(errvfsresult=captive_file_file_info_get(captive_file_object,&file_info)))
 323                 return errvfsresult;
 324         if (file_info.size<endoffile_wanted) {
 325                 if (GNOME_VFS_OK!=(errvfsresult=captive_file_truncate(captive_file_object,endoffile_wanted)))
 326                         return errvfsresult;
 327                 }
 328
 329         file_offset.QuadPart=captive_file_object->offset;
 330         err=NtWriteFile(
 331                         captive_file_object->file_Handle,       /* FileHandle */
 332                         NULL,   /* Event; completion signalling; optional */
 333                         NULL,   /* ApcRoutine; optional */
 334                         NULL,   /* ApcContext; optional */
 335                         &file_IoStatusBlock,    /* IoStatusBlock */
 336                         (gpointer /* de-const */ )buffer,       /* Buffer */
 337                         num_bytes,      /* Length */
 338                         &file_offset,   /* ByteOffset */
 339                         NULL);  /* Key; NULL means no file locking key */
 340         g_return_val_if_fail(NT_SUCCESS(err)==NT_SUCCESS(file_IoStatusBlock.Status),GNOME_VFS_ERROR_GENERIC);
 341         g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
 342         g_return_val_if_fail(file_IoStatusBlock.Information==num_bytes,GNOME_VFS_ERROR_GENERIC);
 343
 344         captive_file_object->offset+=file_IoStatusBlock.Information;
 345         *bytes_written_return=file_IoStatusBlock.Information;
 346         captive_leave();
 347         return GNOME_VFS_OK;
 348 }
 349
 350
 351 GnomeVFSResult captive_file_seek
 352                 (CaptiveFileObject *captive_file_object,GnomeVFSSeekPosition whence,GnomeVFSFileOffset offset)
 353 {
 354         g_return_val_if_fail(captive_file_object!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 355
 356         if (captive_file_object->vfs->is_sandbox_parent)
 357                 return captive_sandbox_parent_file_seek(captive_file_object,whence,offset);
 358
 359         g_return_val_if_fail(captive_file_object->file_Handle!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 360
 361         switch (whence) {
 362                 case GNOME_VFS_SEEK_START:
 363                         captive_file_object->offset=offset;
 364                         break;
 365                 case GNOME_VFS_SEEK_CURRENT:
 366                         if (0
 367                                         || (offset>0 && (captive_file_object->offset+offset)<captive_file_object->offset)
 368                                         || (offset<0 && (captive_file_object->offset+offset)>captive_file_object->offset))
 369                                 return GNOME_VFS_ERROR_BAD_PARAMETERS;
 370                         captive_file_object->offset+=offset;
 371                         break;
 372                 case GNOME_VFS_SEEK_END:
 373                         g_assert_not_reached(); /* NOT IMPLEMENTED YET */
 374                         break;
 375                 default:
 376                         g_return_val_if_reached(GNOME_VFS_ERROR_BAD_PARAMETERS);
 377                 }
 378
 379         captive_leave();
 380         return GNOME_VFS_OK;
 381 }
 382
 383
 384 GnomeVFSResult captive_file_tell(CaptiveFileObject *captive_file_object,GnomeVFSFileOffset *offset_return)
 385 {
 386         g_return_val_if_fail(captive_file_object!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 387         g_return_val_if_fail(offset_return!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 388
 389         if (captive_file_object->vfs->is_sandbox_parent)
 390                 return captive_sandbox_parent_file_tell(captive_file_object,offset_return);
 391
 392         g_return_val_if_fail(captive_file_object->file_Handle!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 393
 394         *offset_return=captive_file_object->offset;
 395         captive_leave();
 396         return GNOME_VFS_OK;
 397 }
 398
 399
 400 GnomeVFSResult captive_file_remove(CaptiveFileObject *captive_file_object)
 401 {
 402 NTSTATUS err;
 403 FILE_DISPOSITION_INFORMATION FileDispositionInformation_struct;
 404 IO_STATUS_BLOCK file_IoStatusBlock;
 405 GnomeVFSResult errvfsresult;
 406
 407         g_return_val_if_fail(captive_file_object!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 408
 409         if (captive_file_object->vfs->is_sandbox_parent)
 410                 return captive_sandbox_parent_file_remove(captive_file_object);
 411
 412         g_return_val_if_fail(captive_file_object->file_Handle!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 413
 414         FileDispositionInformation_struct.DoDeleteFile=TRUE;
 415
 416         err=NtSetInformationFile(
 417                         captive_file_object->file_Handle,       /* FileHandle */
 418                         &file_IoStatusBlock,    /* IoStatusBlock */
 419                         &FileDispositionInformation_struct,     /* FileInformation */
 420                         sizeof(FileDispositionInformation_struct),      /* Length */
 421                         FileDispositionInformation);    /* FileInformationClass */
 422         if (GNOME_VFS_OK!=(errvfsresult=captive_NTSTATUS_to_GnomeVFSResult(err)))
 423                 return errvfsresult;
 424         g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
 425
 426         captive_leave();
 427         return GNOME_VFS_OK;
 428 }
 429
 430
 431 /* Use 'FileNameInformationStruct' identifier instead of the logical 'FileNameInformation'
 432  * to prevent override of enum member 'FileNameInformation'
 433  */
 434 static GnomeVFSResult FileNameInformationStruct_to_GnomeVFSFileInfo(GnomeVFSFileInfo *file_info,
 435                 FILE_NAME_INFORMATION *FileNameInformationStruct)
 436 {
 437 UNICODE_STRING FileName_UnicodeString;
 438
 439         g_return_val_if_fail(file_info!=NULL,GNOME_VFS_ERROR_GENERIC);
 440         g_return_val_if_fail(FileNameInformationStruct!=NULL,GNOME_VFS_ERROR_GENERIC);
 441
 442         FileName_UnicodeString.Length=FileNameInformationStruct->FileNameLength;
 443         FileName_UnicodeString.MaximumLength=FileNameInformationStruct->FileNameLength
 444                         +sizeof(*FileNameInformationStruct->FileName);  /* 0-terminator */
 445
 446 #if 0   /* 'IoStatusBlock->Information' is sometimes weird, do not check it */
 447         g_assert((gpointer)(((char *)FileNameInformationStruct->FileName)+FileName_UnicodeString.Length)
 448                         <=(gpointer)(((char *)FileAllInformationStruct)+IoStatusBlock->Information));
 449                                         /* ensure we fit below '->IoStatusBlock->Information' at least without the 0-terminator */
 450 #endif
 451
 452         FileNameInformationStruct->FileName[FileNameInformationStruct->FileNameLength
 453                         /sizeof(*FileNameInformationStruct->FileName)]=0;       /* 0-terminate it */
 454         FileName_UnicodeString.Buffer=FileNameInformationStruct->FileName;
 455         file_info->name=captive_UnicodeString_to_utf8_malloc(&FileName_UnicodeString);
 456         /* '->name' assumed for 'file_info->valid_fields' */
 457
 458         return GNOME_VFS_OK;
 459 }
 460
 461
 462 /* Use 'FileBasicInformationStruct' identifier instead of the logical 'FileBasicInformation'
 463  * to prevent override of enum member 'FileBasicInformation'
 464  */
 465 static GnomeVFSResult FileBasicInformationStruct_to_GnomeVFSFileInfo(GnomeVFSFileInfo *file_info,
 466                 FILE_BASIC_INFORMATION *FileBasicInformationStruct)
 467 {
 468 BOOLEAN errBOOLEAN;
 469 ULONG tmp_ULONG;
 470
 471         /* FIXME: What is 'FILE_ATTRIBUTE_NORMAL'? */
 472         switch (FileBasicInformationStruct->FileAttributes & (0
 473                         | FILE_ATTRIBUTE_DIRECTORY
 474                         | FILE_ATTRIBUTE_DEVICE)) {
 475                 case 0:                        file_info->type=GNOME_VFS_FILE_TYPE_REGULAR;   break;
 476                 case FILE_ATTRIBUTE_DIRECTORY: file_info->type=GNOME_VFS_FILE_TYPE_DIRECTORY; break;
 477                 case FILE_ATTRIBUTE_DEVICE:    file_info->type=GNOME_VFS_FILE_TYPE_SOCKET;
 478                         /* or GNOME_VFS_FILE_TYPE_CHARACTER_DEVICE or GNOME_VFS_FILE_TYPE_BLOCK_DEVICE ? */
 479                         break;
 480                 default:                       file_info->type=GNOME_VFS_FILE_TYPE_UNKNOWN;   break;
 481                 }
 482         file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_TYPE;
 483
 484         /* we use 0600 for r/w files, 0400 for FILE_ATTRIBUTE_READONLY */
 485         file_info->permissions=GNOME_VFS_PERM_USER_READ;
 486         if (file_info->type==GNOME_VFS_FILE_TYPE_DIRECTORY)
 487                 file_info->permissions|=GNOME_VFS_PERM_USER_EXEC;
 488         if (!(FileBasicInformationStruct->FileAttributes & FILE_ATTRIBUTE_READONLY))
 489                 file_info->permissions|=GNOME_VFS_PERM_USER_WRITE;
 490         file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_PERMISSIONS;
 491
 492         if (FileBasicInformationStruct->LastAccessTime.QuadPart) {      /* it may be 0 if not set */
 493                 errBOOLEAN=RtlTimeToSecondsSince1970(&FileBasicInformationStruct->LastAccessTime,&tmp_ULONG);
 494                 g_assert(errBOOLEAN==TRUE);
 495                 file_info->atime=tmp_ULONG;
 496                 file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_ATIME;
 497                 }
 498
 499         /* it may be 0 if not set */
 500         if (FileBasicInformationStruct->LastWriteTime.QuadPart || FileBasicInformationStruct->ChangeTime.QuadPart) {
 501                 errBOOLEAN=RtlTimeToSecondsSince1970(
 502                                 /* take the more recent (==bigger) time: */
 503                                 (FileBasicInformationStruct->LastWriteTime.QuadPart > FileBasicInformationStruct->ChangeTime.QuadPart
 504                                                 ? &FileBasicInformationStruct->LastWriteTime : &FileBasicInformationStruct->ChangeTime),
 505                                 &tmp_ULONG);
 506                 g_assert(errBOOLEAN==TRUE);
 507                 file_info->mtime=tmp_ULONG;
 508                 file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_MTIME;
 509                 }
 510
 511         if (FileBasicInformationStruct->CreationTime.QuadPart) {        /* it may be 0 if not set */
 512                 errBOOLEAN=RtlTimeToSecondsSince1970(&FileBasicInformationStruct->CreationTime,&tmp_ULONG);
 513                 g_assert(errBOOLEAN==TRUE);
 514                 file_info->ctime=tmp_ULONG;
 515                 file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_CTIME;
 516                 }
 517
 518         return GNOME_VFS_OK;
 519 }
 520
 521
 522 /* Use 'FileStandardInformationStruct' identifier instead of the logical 'FileStandardInformation'
 523  * to prevent override of enum member 'FileStandardInformation'
 524  */
 525 static GnomeVFSResult FileStandardInformationStruct_to_GnomeVFSFileInfo(GnomeVFSFileInfo *file_info,
 526                 FILE_STANDARD_INFORMATION *FileStandardInformationStruct)
 527 {
 528         file_info->size=FileStandardInformationStruct->EndOfFile.QuadPart;
 529         file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_SIZE;
 530
 531         file_info->block_count=FileStandardInformationStruct->AllocationSize.QuadPart/512;
 532         file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_BLOCK_COUNT;
 533
 534         return GNOME_VFS_OK;
 535 }
 536
 537
 538 GnomeVFSResult captive_file_file_info_get(CaptiveFileObject *captive_file_object,
 539                 GnomeVFSFileInfo *file_info)
 540 {
 541 NTSTATUS err;
 542 IO_STATUS_BLOCK file_IoStatusBlock;
 543 FILE_NAME_INFORMATION *FileNameInformationStruct;
 544 FILE_BASIC_INFORMATION *FileBasicInformationStruct;
 545 FILE_STANDARD_INFORMATION *FileStandardInformationStruct;
 546 GnomeVFSResult errvfsresult;
 547 char QueryFile_buf[sizeof(FILE_NAME_INFORMATION)
 548                 +0x1000 /* max 'FileName' length, 255 should be enough */ * sizeof(WCHAR /* *FILE_ALL_INFORMATION.NameInformation.FileName */ )];
 549
 550         g_return_val_if_fail(captive_file_object!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 551         g_return_val_if_fail(file_info!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 552
 553         if (captive_file_object->vfs->is_sandbox_parent)
 554                 return captive_sandbox_parent_file_file_info_get(captive_file_object,file_info);
 555
 556         g_return_val_if_fail(captive_file_object->file_Handle!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 557
 558         /* ntfs.sys of NT-5.1sp1 has *(FILE_BASIC_INFORMATION *)FILE_ALL_INFORMATION.BasicInformation
 559          * size 0x28 although reactos includes and all the information says 0x24.
 560          * fastfat.sys of NT-5.1sp1 also has the 'official' sizeof 0x24.
 561          * It would be a bit of heuristic to correctly detect its expected sizeof.
 562          */
 563
 564         file_info->valid_fields=0;
 565
 566         file_info->flags=GNOME_VFS_FILE_FLAGS_LOCAL;
 567         file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_FLAGS;
 568
 569         /* query NameInformation */
 570         FileNameInformationStruct=(void *)QueryFile_buf;
 571         err=NtQueryInformationFile(
 572                         captive_file_object->file_Handle,       /* FileHandle */
 573                         &file_IoStatusBlock,    /* IoStatusBlock */
 574                         (gpointer)QueryFile_buf,        /* FileInformation */
 575                         sizeof(QueryFile_buf)   /* Length */
 576                                         -sizeof(*FileNameInformationStruct->FileName),  /* reserve space for a possible 0-terminator */
 577                         FileNameInformation);   /* FileInformationClass; =>FILE_NAME_INFORMATION */
 578         if (GNOME_VFS_OK!=(errvfsresult=captive_NTSTATUS_to_GnomeVFSResult(err)))
 579                 return errvfsresult;
 580         g_return_val_if_fail(NT_SUCCESS(err)==NT_SUCCESS(file_IoStatusBlock.Status),GNOME_VFS_ERROR_GENERIC);
 581         g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
 582         errvfsresult=FileNameInformationStruct_to_GnomeVFSFileInfo(file_info,FileNameInformationStruct);
 583         g_return_val_if_fail(errvfsresult==GNOME_VFS_OK,errvfsresult);
 584
 585         /* query BasicInformation */
 586         FileBasicInformationStruct=(void *)QueryFile_buf;
 587         err=NtQueryInformationFile(
 588                         captive_file_object->file_Handle,       /* FileHandle */
 589                         &file_IoStatusBlock,    /* IoStatusBlock */
 590                         (gpointer)QueryFile_buf,        /* FileInformation */
 591                         sizeof(QueryFile_buf),  /* Length */
 592                         FileBasicInformation);  /* FileInformationClass; =>FILE_BASIC_INFORMATION */
 593         if (GNOME_VFS_OK!=(errvfsresult=captive_NTSTATUS_to_GnomeVFSResult(err)))
 594                 return errvfsresult;
 595         g_return_val_if_fail(NT_SUCCESS(err)==NT_SUCCESS(file_IoStatusBlock.Status),GNOME_VFS_ERROR_GENERIC);
 596         g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
 597         errvfsresult=FileBasicInformationStruct_to_GnomeVFSFileInfo(file_info,FileBasicInformationStruct);
 598         g_return_val_if_fail(errvfsresult==GNOME_VFS_OK,errvfsresult);
 599
 600         /* query StandardInformation */
 601         FileStandardInformationStruct=(void *)QueryFile_buf;
 602         err=NtQueryInformationFile(
 603                         captive_file_object->file_Handle,       /* FileHandle */
 604                         &file_IoStatusBlock,    /* IoStatusBlock */
 605                         (gpointer)QueryFile_buf,        /* FileInformation */
 606                         sizeof(QueryFile_buf),  /* Length */
 607                         FileStandardInformation);       /* FileInformationClass; =>FILE_STANDARD_INFORMATION */
 608         if (GNOME_VFS_OK!=(errvfsresult=captive_NTSTATUS_to_GnomeVFSResult(err)))
 609                 return errvfsresult;
 610         g_return_val_if_fail(NT_SUCCESS(err)==NT_SUCCESS(file_IoStatusBlock.Status),GNOME_VFS_ERROR_GENERIC);
 611         g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
 612         errvfsresult=FileStandardInformationStruct_to_GnomeVFSFileInfo(file_info,FileStandardInformationStruct);
 613         g_return_val_if_fail(errvfsresult==GNOME_VFS_OK,errvfsresult);
 614
 615         captive_leave();
 616         return GNOME_VFS_OK;
 617 }
 618
 619
 620 GnomeVFSResult captive_file_file_info_set(CaptiveFileObject *captive_file_object,
 621     const GnomeVFSFileInfo *info,GnomeVFSSetFileInfoMask mask)
 622 {
 623         g_return_val_if_fail(captive_file_object!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 624         g_return_val_if_fail(info!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 625
 626         if (captive_file_object->vfs->is_sandbox_parent)
 627                 return captive_sandbox_parent_file_file_info_set(captive_file_object,info,mask);
 628
 629         g_return_val_if_fail(captive_file_object->file_Handle!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 630
 631         if (mask & GNOME_VFS_SET_FILE_INFO_NAME) {
 632 gchar *name_dirname,*name_basename;
 633 UNICODE_STRING *name_UnicodeString;
 634 FILE_RENAME_INFORMATION *FileRenameInformation_structp;
 635 gsize FileRenameInformation_struct_len;
 636 IO_STATUS_BLOCK file_IoStatusBlock;
 637 NTSTATUS err;
 638 GnomeVFSResult errvfsresult;
 639
 640                 /* non-existing dirname assertion */
 641                 name_dirname=g_path_get_dirname(info->name);
 642                 if (*name_dirname) {
 643                         g_assert_not_reached();
 644                         errvfsresult=GNOME_VFS_ERROR_BAD_PARAMETERS;
 645                         goto err;
 646                         }
 647
 648                 /* fully-matching basename assertion */
 649                 name_basename=g_path_get_basename(info->name);
 650                 if (strcmp(name_basename,info->name)) {
 651                         g_assert_not_reached();
 652                         errvfsresult=GNOME_VFS_ERROR_BAD_PARAMETERS;
 653                         goto err_free_name_dirname;
 654                         }
 655
 656                 name_UnicodeString=captive_utf8_to_UnicodeString_alloca(info->name);
 657                 FileRenameInformation_struct_len=sizeof(*FileRenameInformation_structp)
 658                                 +name_UnicodeString->MaximumLength;     /* ==Length+(0-terminator); is the terminator needed? */
 659
 660                 FileRenameInformation_structp=g_alloca(FileRenameInformation_struct_len);
 661                 FileRenameInformation_structp->Replace=FALSE;
 662                 FileRenameInformation_structp->RootDir=NULL;    /* we do 'simple rename' here */
 663                 FileRenameInformation_structp->FileNameLength=name_UnicodeString->Length;
 664                 memcpy(FileRenameInformation_structp->FileName,name_UnicodeString->Buffer,
 665                                 name_UnicodeString->MaximumLength);     /* ==Length+(0-terminator); is the terminator needed? */
 666
 667                 err=NtSetInformationFile(
 668                                 captive_file_object->file_Handle,       /* FileHandle */
 669                                 &file_IoStatusBlock,    /* IoStatusBlock */
 670                                 FileRenameInformation_structp,  /* FileInformation */
 671                                 FileRenameInformation_struct_len,       /* Length */
 672                                 FileRenameInformation); /* FileInformationClass */
 673                 if (GNOME_VFS_OK!=(errvfsresult=captive_NTSTATUS_to_GnomeVFSResult(err)))
 674                         goto err_free_name_basename;
 675
 676 err_free_name_basename:
 677                 g_free(name_basename);
 678 err_free_name_dirname:
 679                 g_free(name_dirname);
 680 err:
 681
 682                 if (errvfsresult!=GNOME_VFS_OK)
 683                         return errvfsresult;
 684                 g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
 685                 }
 686
 687         if (mask & (GNOME_VFS_SET_FILE_INFO_PERMISSIONS | GNOME_VFS_SET_FILE_INFO_TIME)) {
 688 char FileBasicInformation_buf[sizeof(FILE_BASIC_INFORMATION)+4];
 689 FILE_BASIC_INFORMATION *FileBasicInformationp=(FILE_BASIC_INFORMATION *)FileBasicInformation_buf;
 690 IO_STATUS_BLOCK file_IoStatusBlock;
 691 NTSTATUS err;
 692
 693                 /* FIXME: Everywhere is is the declaration with 4xLARGE_INTEGER+1xULONG==36 bytes
 694                  * but the precompiled ext2fsd.sys wants 40 bytes - why?
 695                  * The same case applies to ntfs.sys of NT-5.1sp1.
 696                  */
 697                 g_assert(sizeof(FILE_BASIC_INFORMATION)==36);
 698                 g_assert(sizeof(FileBasicInformation_buf)==40);
 699                 err=NtQueryInformationFile(
 700                                 captive_file_object->file_Handle,       /* FileHandle */
 701                                 &file_IoStatusBlock,    /* IoStatusBlock */
 702                                 FileBasicInformation_buf,       /* FileInformation */
 703                                 sizeof(FileBasicInformation_buf),       /* Length */
 704                                 FileBasicInformation);  /* FileInformationClass */
 705                 g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
 706
 707                 if (mask & GNOME_VFS_SET_FILE_INFO_PERMISSIONS) {
 708                         FileBasicInformationp->FileAttributes&=~FILE_ATTRIBUTE_READONLY;
 709                         g_assert(info->valid_fields & GNOME_VFS_FILE_INFO_FIELDS_PERMISSIONS);
 710                         if (!(info->permissions&0200))
 711                                 FileBasicInformationp->FileAttributes|=FILE_ATTRIBUTE_READONLY;
 712                         }
 713
 714                 if (mask & GNOME_VFS_SET_FILE_INFO_TIME) {
 715                         g_assert(info->valid_fields & (0
 716                                         | GNOME_VFS_FILE_INFO_FIELDS_ATIME
 717                                         | GNOME_VFS_FILE_INFO_FIELDS_MTIME
 718                                         | GNOME_VFS_FILE_INFO_FIELDS_CTIME));
 719                         if (info->valid_fields&GNOME_VFS_FILE_INFO_FIELDS_ATIME) {
 720                                 RtlSecondsSince1970ToTime(
 721                                                 info->atime,    /* SecondsSince1970 */
 722                                                 &FileBasicInformationp->LastAccessTime);        /* Time */
 723                                 }
 724                         if (info->valid_fields&GNOME_VFS_FILE_INFO_FIELDS_MTIME) {
 725                                 RtlSecondsSince1970ToTime(
 726                                                 info->mtime,    /* SecondsSince1970 */
 727                                                 &FileBasicInformationp->LastWriteTime); /* Time */
 728                                 FileBasicInformationp->ChangeTime=FileBasicInformationp->LastWriteTime;
 729                                 }
 730                         if (info->valid_fields&GNOME_VFS_FILE_INFO_FIELDS_CTIME) {
 731                                 RtlSecondsSince1970ToTime(
 732                                                 info->ctime,    /* SecondsSince1970 */
 733                                                 &FileBasicInformationp->CreationTime);  /* Time */
 734                                 }
 735                         }
 736
 737                 err=NtSetInformationFile(
 738                                 captive_file_object->file_Handle,       /* FileHandle */
 739                                 &file_IoStatusBlock,    /* IoStatusBlock */
 740                                 FileBasicInformation_buf,       /* FileInformation */
 741                                 sizeof(FileBasicInformation_buf),       /* Length */
 742                                 FileBasicInformation);  /* FileInformationClass */
 743                 g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
 744                 }
 745
 746         if (mask & GNOME_VFS_SET_FILE_INFO_OWNER) {
 747                 /* FIXME: g_assert(info->valid_fields & ???); */
 748                 /* owner ignored for W32 */
 749                 }
 750
 751         captive_leave();
 752         return GNOME_VFS_OK;
 753 }
 754
 755
 756 GnomeVFSResult captive_file_truncate(CaptiveFileObject *captive_file_object,GnomeVFSFileSize file_size)
 757 {
 758 NTSTATUS err;
 759 FILE_END_OF_FILE_INFORMATION FileEndOfFileInformation_struct;
 760 IO_STATUS_BLOCK file_IoStatusBlock;
 761 GnomeVFSResult errvfsresult;
 762
 763         g_return_val_if_fail(captive_file_object!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 764
 765         if (captive_file_object->vfs->is_sandbox_parent)
 766                 return captive_sandbox_parent_file_truncate(captive_file_object,file_size);
 767
 768         g_return_val_if_fail(captive_file_object->file_Handle!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 769
 770         FileEndOfFileInformation_struct.EndOfFile.QuadPart=file_size;
 771
 772         err=NtSetInformationFile(
 773                         captive_file_object->file_Handle,       /* FileHandle */
 774                         &file_IoStatusBlock,    /* IoStatusBlock */
 775                         &FileEndOfFileInformation_struct,       /* FileInformation */
 776                         sizeof(FileEndOfFileInformation_struct),        /* Length */
 777                         FileEndOfFileInformation);      /* FileInformationClass */
 778         if (GNOME_VFS_OK!=(errvfsresult=captive_NTSTATUS_to_GnomeVFSResult(err)))
 779                 return errvfsresult;
 780         g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
 781
 782         captive_leave();
 783         return GNOME_VFS_OK;
 784 }
 785
 786
 787 GnomeVFSResult captive_file_move(CaptiveFileObject *captive_file_object_old,const gchar *pathname_new,gboolean force_replace)
 788 {
 789 NTSTATUS err;
 790 FILE_RENAME_INFORMATION *FileRenameInformation_structp;
 791 IO_STATUS_BLOCK file_IoStatusBlock;
 792 GnomeVFSResult errvfsresult;
 793 OBJECT_ATTRIBUTES pathname_new_ObjectAttributes;
 794
 795         g_return_val_if_fail(captive_file_object_old!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 796         g_return_val_if_fail(pathname_new!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 797
 798         if (captive_file_object_old->vfs->is_sandbox_parent)
 799                 return captive_sandbox_parent_file_move(captive_file_object_old,pathname_new,force_replace);
 800
 801         g_return_val_if_fail(captive_file_object_old->file_Handle!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 802
 803         errvfsresult=captive_ObjectAttributes_init(pathname_new,&pathname_new_ObjectAttributes);
 804         g_return_val_if_fail(errvfsresult==GNOME_VFS_OK,errvfsresult);
 805
 806         FileRenameInformation_structp=
 807                         g_alloca(sizeof(*FileRenameInformation_structp)+pathname_new_ObjectAttributes.ObjectName->MaximumLength);
 808         FileRenameInformation_structp->Replace=force_replace;
 809         FileRenameInformation_structp->RootDir=0;       /* AFAIK never set by orig W32 */
 810         FileRenameInformation_structp->FileNameLength=pathname_new_ObjectAttributes.ObjectName->Length;
 811         memcpy(FileRenameInformation_structp->FileName,pathname_new_ObjectAttributes.ObjectName->Buffer,
 812                         pathname_new_ObjectAttributes.ObjectName->MaximumLength);
 813
 814         err=NtSetInformationFile(
 815                         captive_file_object_old->file_Handle,   /* FileHandle */
 816                         &file_IoStatusBlock,    /* IoStatusBlock */
 817                         FileRenameInformation_structp,  /* FileInformation */
 818                         sizeof(*FileRenameInformation_structp)+pathname_new_ObjectAttributes.ObjectName->MaximumLength, /* Length */
 819                         FileRenameInformation); /* FileInformationClass */
 820         if (GNOME_VFS_OK!=(errvfsresult=captive_NTSTATUS_to_GnomeVFSResult(err)))
 821                 goto err_free_ObjectAttributes;
 822         g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
 823
 824         errvfsresult=GNOME_VFS_OK;
 825
 826 err_free_ObjectAttributes:
 827         g_free(pathname_new_ObjectAttributes.ObjectName);       /* left from captive_file_uri_parent_init() */
 828
 829         captive_leave();
 830         return errvfsresult;
 831 }