2 * captive vfs 'file' interface to reactos
3 * Copyright (C) 2002-2003 Jan Kratochvil <project-captive@jankratochvil.net>
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
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.
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
22 #include "file-slave.h" /* self */
23 #include "captive/client-file.h" /* for CaptiveFileObject */
24 #include "file.h" /* for CaptiveFileObject priv */
25 #include "directory.h"
27 #include <glib/gmessages.h>
28 #include "captive/unicode.h"
29 #include "reactos/ntos/types.h" /* for HANDLE */
30 #include "reactos/ddk/iotypes.h" /* for IO_STATUS_BLOCK */
31 #include "reactos/ddk/iofuncs.h" /* for IoCreateFile() */
33 #include "captive/client-directory.h"
34 #include "reactos/ddk/obfuncs.h" /* for ObReferenceObjectByHandle() */
35 #include "captive/macros.h"
36 #include "captive/leave.h"
37 #include "captive/usecount.h"
39 #include "vfs-slave.h"
43 #define MAX_FILE_WRITTEN 0x100000 /* FIXME: Workaround memory consumption for non-journalled fastfat.sys */
46 struct _CaptiveFileSlaveObject {
47 CaptiveFileObject parent_instance;
51 GnomeVFSFileOffset offset;
53 struct _CaptiveFileSlaveObjectClass {
54 CaptiveFileObjectClass parent_class;
58 static gpointer captive_file_slave_object_parent_class=NULL;
61 static GnomeVFSResult captive_file_slave_close(CaptiveFileObject *captive_file_object);
62 static GnomeVFSResult captive_file_slave_read(CaptiveFileObject *captive_file_object,
63 gpointer buffer,GnomeVFSFileSize num_bytes,GnomeVFSFileSize *bytes_read_return);
64 static GnomeVFSResult captive_file_slave_write(CaptiveFileObject *captive_file_object,
65 gconstpointer buffer,GnomeVFSFileSize num_bytes,GnomeVFSFileSize *bytes_written_return);
66 static GnomeVFSResult captive_file_slave_seek
67 (CaptiveFileObject *captive_file_object,GnomeVFSSeekPosition whence,GnomeVFSFileOffset offset);
68 static GnomeVFSResult captive_file_slave_tell(CaptiveFileObject *captive_file_object,GnomeVFSFileOffset *offset_return);
69 static GnomeVFSResult captive_file_slave_remove(CaptiveFileObject *captive_file_object);
70 static GnomeVFSResult captive_file_slave_file_info_get
71 (CaptiveFileObject *captive_file_object,GnomeVFSFileInfo *file_info);
72 static GnomeVFSResult captive_file_slave_file_info_set
73 (CaptiveFileObject *captive_file_object,const GnomeVFSFileInfo *info,GnomeVFSSetFileInfoMask mask);
74 static GnomeVFSResult captive_file_slave_truncate(CaptiveFileObject *captive_file_object,GnomeVFSFileSize file_size);
75 static GnomeVFSResult captive_file_slave_move
76 (CaptiveFileObject *captive_file_object_old,const gchar *pathname_new,gboolean force_replace);
79 static void captive_file_slave_object_finalize(CaptiveFileSlaveObject *captive_file_slave_object)
81 g_return_if_fail(captive_file_slave_object!=NULL);
83 captive_file_slave_close(CAPTIVE_FILE_OBJECT(captive_file_slave_object)); /* errors ignored */
85 G_OBJECT_CLASS(captive_file_slave_object_parent_class)->finalize((GObject *)captive_file_slave_object);
89 static void captive_file_slave_object_class_init(CaptiveFileSlaveObjectClass *class)
91 GObjectClass *gobject_class=G_OBJECT_CLASS(class);
92 CaptiveFileObjectClass *captive_file_object_class=CAPTIVE_FILE_OBJECT_CLASS(class);
94 captive_file_slave_object_parent_class=g_type_class_ref(g_type_parent(G_TYPE_FROM_CLASS(class)));
95 gobject_class->finalize=(void (*)(GObject *object))captive_file_slave_object_finalize;
97 captive_file_object_class->read=captive_file_slave_read;
98 captive_file_object_class->write=captive_file_slave_write;
99 captive_file_object_class->seek=captive_file_slave_seek;
100 captive_file_object_class->tell=captive_file_slave_tell;
101 captive_file_object_class->remove=captive_file_slave_remove;
102 captive_file_object_class->file_info_get=captive_file_slave_file_info_get;
103 captive_file_object_class->file_info_set=captive_file_slave_file_info_set;
104 captive_file_object_class->truncate=captive_file_slave_truncate;
105 captive_file_object_class->move=captive_file_slave_move;
109 static void captive_file_slave_object_init(CaptiveFileSlaveObject *captive_file_slave_object)
111 captive_file_slave_object->file_Handle=NULL;
115 GType captive_file_slave_object_get_type(void)
117 static GType captive_file_slave_object_type=0;
119 if (!captive_file_slave_object_type) {
120 static const GTypeInfo captive_file_slave_object_info={
121 sizeof(CaptiveFileSlaveObjectClass),
122 NULL, /* base_init */
123 NULL, /* base_finalize */
124 (GClassInitFunc)captive_file_slave_object_class_init,
125 NULL, /* class_finalize */
126 NULL, /* class_data */
127 sizeof(CaptiveFileSlaveObject),
129 (GInstanceInitFunc)captive_file_slave_object_init,
132 captive_file_slave_object_type=g_type_register_static(CAPTIVE_FILE_TYPE_OBJECT,
133 "CaptiveFileSlaveObject",&captive_file_slave_object_info,0);
136 return captive_file_slave_object_type;
140 static GnomeVFSResult captive_file_slave_new_internal(CaptiveFileSlaveObject *captive_file_slave_object,
141 const gchar *pathname,GnomeVFSOpenMode mode,gboolean create,gboolean create_exclusive,guint create_perm)
143 IO_STATUS_BLOCK file_IoStatusBlock;
144 GnomeVFSResult errvfsresult;
145 OBJECT_ATTRIBUTES file_ObjectAttributes;
149 g_return_val_if_fail(captive_file_slave_object!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
150 g_return_val_if_fail(pathname!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
152 errvfsresult=captive_ObjectAttributes_init(pathname,&file_ObjectAttributes);
153 g_return_val_if_fail(errvfsresult==GNOME_VFS_OK,errvfsresult);
157 &file_Handle, /* FileHandle */
159 |(!(mode&GNOME_VFS_OPEN_READ ) ? 0 : FILE_READ_DATA)
160 |(!(mode&GNOME_VFS_OPEN_WRITE) ? 0 : FILE_WRITE_DATA | FILE_APPEND_DATA | FILE_WRITE_ATTRIBUTES)
161 |( mode!=0 ? 0 : FILE_READ_ATTRIBUTES)
162 , /* DesiredAccess */
163 &file_ObjectAttributes, /* ObjectAttributes */
164 &file_IoStatusBlock, /* IoStatusBlock */
165 NULL, /* AllocationSize; ignored for open */
166 (!create || create_perm&0200 ? FILE_ATTRIBUTE_NORMAL: FILE_ATTRIBUTE_READONLY), /* FileAttributes; ignored for open */
167 (!create || !create_exclusive /* ShareAccess; 0 means exclusive */
168 ? (FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE)
170 (!create ? FILE_OPEN : FILE_CREATE), /* CreateDisposition */
171 /* FILE_SYNCHRONOUS_IO_{,NON}ALERT: We need to allow W32 filesystem
172 * any waits to not to let it return STATUS_CANT_WAIT us.
173 * Alertability should have only effect on asynchronous events
174 * from KeWaitForSingleObject() by setting/clearing its parameter 'Alertable'.
176 FILE_SYNCHRONOUS_IO_ALERT /* CreateOptions */
177 /* sniffed: | FILE_DIRECTORY_FILE */
178 /* sniffed: | FILE_OPEN_FOR_BACKUP_INTENT */
182 CreateFileTypeNone, /* CreateFileType */
183 NULL, /* ExtraCreateParameters */
185 g_free(file_ObjectAttributes.ObjectName); /* left from captive_file_slave_uri_parent_init() */
186 g_return_val_if_fail(NT_SUCCESS(err)==NT_SUCCESS(file_IoStatusBlock.Status),GNOME_VFS_ERROR_GENERIC);
187 if (GNOME_VFS_OK!=(errvfsresult=captive_NTSTATUS_to_GnomeVFSResult(err)))
189 g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
190 g_return_val_if_fail(file_IoStatusBlock.Information
191 ==(!create ? FILE_OPENED : FILE_CREATED),
192 GNOME_VFS_ERROR_GENERIC);
194 captive_file_slave_object->file_Handle=file_Handle;
200 GnomeVFSResult captive_file_slave_new_open(CaptiveFileObject **captive_file_object_return,
201 CaptiveVfsObject *captive_vfs_object,const gchar *pathname,GnomeVFSOpenMode mode)
204 CaptiveFileSlaveObject *captive_file_slave_object;
206 g_return_val_if_fail(captive_file_object_return!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
207 g_return_val_if_fail(CAPTIVE_VFS_SLAVE_IS_OBJECT(captive_vfs_object),GNOME_VFS_ERROR_BAD_PARAMETERS);
208 g_return_val_if_fail(pathname!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
210 captive_file_slave_object=g_object_new(
211 CAPTIVE_FILE_SLAVE_TYPE_OBJECT, /* object_type */
212 NULL); /* first_property_name; FIXME: support properties */
214 captive_file_init(CAPTIVE_FILE_OBJECT(captive_file_slave_object),captive_vfs_object);
216 *captive_file_object_return=CAPTIVE_FILE_OBJECT(captive_file_slave_object);
218 r=captive_file_slave_new_internal(captive_file_slave_object,pathname,mode,
220 FALSE, /* create_exclusive; ignored */
221 0); /* create_perm; ignored */
225 captive_usecount(+1);
227 g_object_unref(captive_file_slave_object);
228 *captive_file_object_return=NULL;
234 GnomeVFSResult captive_file_slave_new_create(CaptiveFileObject **captive_file_object_return,
235 CaptiveVfsObject *captive_vfs_object,const gchar *pathname,GnomeVFSOpenMode mode,gboolean exclusive,guint perm)
238 CaptiveFileSlaveObject *captive_file_slave_object;
240 g_return_val_if_fail(captive_file_object_return!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
241 g_return_val_if_fail(CAPTIVE_VFS_SLAVE_IS_OBJECT(captive_vfs_object),GNOME_VFS_ERROR_BAD_PARAMETERS);
242 g_return_val_if_fail(pathname!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
244 captive_file_slave_object=g_object_new(
245 CAPTIVE_FILE_SLAVE_TYPE_OBJECT, /* object_type */
246 NULL); /* first_property_name; FIXME: support properties */
248 captive_file_init(CAPTIVE_FILE_OBJECT(captive_file_slave_object),captive_vfs_object);
250 *captive_file_object_return=CAPTIVE_FILE_OBJECT(captive_file_slave_object);
252 r=captive_file_slave_new_internal(captive_file_slave_object,pathname,mode,
254 exclusive, /* create_exclusive */
255 perm); /* create_perm */
259 captive_usecount(+1);
261 g_object_unref(captive_file_slave_object);
262 *captive_file_object_return=NULL;
268 static GnomeVFSResult captive_file_slave_close(CaptiveFileObject *captive_file_object)
270 CaptiveFileSlaveObject *captive_file_slave_object;
274 g_return_val_if_fail(CAPTIVE_FILE_SLAVE_IS_OBJECT(captive_file_object),GNOME_VFS_ERROR_BAD_PARAMETERS);
276 captive_file_slave_object=CAPTIVE_FILE_SLAVE_OBJECT(captive_file_object);
278 if (captive_file_slave_object->file_Handle!=NULL) { /* not yet already closed */
279 captive_usecount(-1); /* close() errors notwithstanding */
281 file_Handle=captive_file_slave_object->file_Handle;
282 captive_file_slave_object->file_Handle=NULL;
283 err=NtClose(file_Handle);
284 g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
292 GnomeVFSResult captive_file_slave_read(CaptiveFileObject *captive_file_object,
293 gpointer buffer,GnomeVFSFileSize num_bytes,GnomeVFSFileSize *bytes_read_return)
295 CaptiveFileSlaveObject *captive_file_slave_object;
297 IO_STATUS_BLOCK file_IoStatusBlock;
298 LARGE_INTEGER file_offset;
299 GnomeVFSResult errvfsresult;
301 g_return_val_if_fail(CAPTIVE_FILE_SLAVE_IS_OBJECT(captive_file_object),GNOME_VFS_ERROR_BAD_PARAMETERS);
302 g_return_val_if_fail(buffer!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
303 g_return_val_if_fail(bytes_read_return!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
304 g_return_val_if_fail(num_bytes==(ULONG)num_bytes,GNOME_VFS_ERROR_BAD_PARAMETERS);
306 captive_file_slave_object=CAPTIVE_FILE_SLAVE_OBJECT(captive_file_object);
308 g_return_val_if_fail(captive_file_slave_object->file_Handle!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
310 file_offset.QuadPart=captive_file_slave_object->offset;
312 captive_file_slave_object->file_Handle, /* FileHandle */
313 NULL, /* EventHandle; completion signalling; optional */
314 NULL, /* ApcRoutine; optional */
315 NULL, /* ApcContext; optional */
316 &file_IoStatusBlock, /* IoStatusBlock */
318 num_bytes, /* Length */
319 &file_offset, /* ByteOffset */
320 NULL); /* Key; NULL means no file locking key */
321 if (err==STATUS_END_OF_FILE) {
322 g_return_val_if_fail(file_IoStatusBlock.Status==STATUS_END_OF_FILE,GNOME_VFS_ERROR_GENERIC);
323 g_return_val_if_fail(file_IoStatusBlock.Information==0,GNOME_VFS_ERROR_GENERIC);
324 *bytes_read_return=0;
325 return GNOME_VFS_ERROR_EOF;
327 g_return_val_if_fail(file_IoStatusBlock.Information>0,GNOME_VFS_ERROR_GENERIC); /* if not STATUS_END_OF_FILE... */
328 if (GNOME_VFS_OK!=(errvfsresult=captive_NTSTATUS_to_GnomeVFSResult(err)))
330 g_return_val_if_fail(NT_SUCCESS(err)==NT_SUCCESS(file_IoStatusBlock.Status),GNOME_VFS_ERROR_GENERIC);
331 g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
332 g_return_val_if_fail(file_IoStatusBlock.Information<=num_bytes,GNOME_VFS_ERROR_GENERIC);
334 captive_file_slave_object->offset+=file_IoStatusBlock.Information;
335 *bytes_read_return=file_IoStatusBlock.Information;
341 GnomeVFSResult captive_file_slave_write(CaptiveFileObject *captive_file_object,
342 gconstpointer buffer,GnomeVFSFileSize num_bytes,GnomeVFSFileSize *bytes_written_return)
344 CaptiveFileSlaveObject *captive_file_slave_object;
346 IO_STATUS_BLOCK file_IoStatusBlock;
347 LARGE_INTEGER file_offset;
348 GnomeVFSFileInfo file_info;
349 GnomeVFSFileSize endoffile_wanted;
350 GnomeVFSResult errvfsresult;
351 static GnomeVFSFileSize total_written=0;
353 g_return_val_if_fail(CAPTIVE_FILE_SLAVE_IS_OBJECT(captive_file_object),GNOME_VFS_ERROR_BAD_PARAMETERS);
354 g_return_val_if_fail(buffer!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
355 g_return_val_if_fail(bytes_written_return!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
356 g_return_val_if_fail(num_bytes==(ULONG)num_bytes,GNOME_VFS_ERROR_BAD_PARAMETERS);
358 captive_file_slave_object=CAPTIVE_FILE_SLAVE_OBJECT(captive_file_object);
360 g_return_val_if_fail(captive_file_slave_object->file_Handle!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
362 /* FIXME: Workaround memory consumption for non-journalled fastfat.sys */
363 if (total_written>=MAX_FILE_WRITTEN && captive_options->sandbox)
364 return GNOME_VFS_ERROR_SERVICE_OBSOLETE;
365 total_written+=num_bytes;
367 if ((GnomeVFSFileOffset)(captive_file_slave_object->offset+num_bytes) < captive_file_slave_object->offset)
368 return GNOME_VFS_ERROR_TOO_BIG;
369 endoffile_wanted=captive_file_slave_object->offset+num_bytes;
370 if (GNOME_VFS_OK!=(errvfsresult=captive_file_slave_file_info_get(
371 CAPTIVE_FILE_OBJECT(captive_file_slave_object),&file_info)))
373 if (file_info.size<endoffile_wanted) {
374 if (GNOME_VFS_OK!=(errvfsresult=captive_file_slave_truncate(
375 CAPTIVE_FILE_OBJECT(captive_file_slave_object),endoffile_wanted)))
379 file_offset.QuadPart=captive_file_slave_object->offset;
381 captive_file_slave_object->file_Handle, /* FileHandle */
382 NULL, /* Event; completion signalling; optional */
383 NULL, /* ApcRoutine; optional */
384 NULL, /* ApcContext; optional */
385 &file_IoStatusBlock, /* IoStatusBlock */
386 (gpointer /* de-const */ )buffer, /* Buffer */
387 num_bytes, /* Length */
388 &file_offset, /* ByteOffset */
389 NULL); /* Key; NULL means no file locking key */
390 g_return_val_if_fail(NT_SUCCESS(err)==NT_SUCCESS(file_IoStatusBlock.Status),GNOME_VFS_ERROR_GENERIC);
391 g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
392 if (!file_IoStatusBlock.Information) {
393 /* FIXME: Check ExRaiseStatus(STATUS_LOG_FILE_FULL);
394 * really occured. We expect so and we will remount the volume.
396 *bytes_written_return=0;
397 return GNOME_VFS_ERROR_SERVICE_OBSOLETE;
399 g_return_val_if_fail(file_IoStatusBlock.Information==num_bytes,GNOME_VFS_ERROR_GENERIC);
401 captive_file_slave_object->offset+=file_IoStatusBlock.Information;
402 *bytes_written_return=file_IoStatusBlock.Information;
408 GnomeVFSResult captive_file_slave_seek
409 (CaptiveFileObject *captive_file_object,GnomeVFSSeekPosition whence,GnomeVFSFileOffset offset)
411 CaptiveFileSlaveObject *captive_file_slave_object;
413 g_return_val_if_fail(CAPTIVE_FILE_SLAVE_IS_OBJECT(captive_file_object),GNOME_VFS_ERROR_BAD_PARAMETERS);
415 captive_file_slave_object=CAPTIVE_FILE_SLAVE_OBJECT(captive_file_object);
417 g_return_val_if_fail(captive_file_slave_object->file_Handle!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
420 case GNOME_VFS_SEEK_START:
421 captive_file_slave_object->offset=offset;
423 case GNOME_VFS_SEEK_CURRENT:
425 || (offset>0 && (captive_file_slave_object->offset+offset)<captive_file_slave_object->offset)
426 || (offset<0 && (captive_file_slave_object->offset+offset)>captive_file_slave_object->offset))
427 return GNOME_VFS_ERROR_BAD_PARAMETERS;
428 captive_file_slave_object->offset+=offset;
430 case GNOME_VFS_SEEK_END:
431 g_assert_not_reached(); /* NOT IMPLEMENTED YET */
434 g_return_val_if_reached(GNOME_VFS_ERROR_BAD_PARAMETERS);
442 GnomeVFSResult captive_file_slave_tell(CaptiveFileObject *captive_file_object,GnomeVFSFileOffset *offset_return)
444 CaptiveFileSlaveObject *captive_file_slave_object;
446 g_return_val_if_fail(CAPTIVE_FILE_SLAVE_IS_OBJECT(captive_file_object),GNOME_VFS_ERROR_BAD_PARAMETERS);
447 g_return_val_if_fail(offset_return!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
449 captive_file_slave_object=CAPTIVE_FILE_SLAVE_OBJECT(captive_file_object);
451 g_return_val_if_fail(captive_file_slave_object->file_Handle!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
453 *offset_return=captive_file_slave_object->offset;
459 GnomeVFSResult captive_file_slave_remove(CaptiveFileObject *captive_file_object)
461 CaptiveFileSlaveObject *captive_file_slave_object;
463 FILE_DISPOSITION_INFORMATION FileDispositionInformation_struct;
464 IO_STATUS_BLOCK file_IoStatusBlock;
465 GnomeVFSResult errvfsresult;
467 g_return_val_if_fail(CAPTIVE_FILE_SLAVE_IS_OBJECT(captive_file_object),GNOME_VFS_ERROR_BAD_PARAMETERS);
469 captive_file_slave_object=CAPTIVE_FILE_SLAVE_OBJECT(captive_file_object);
471 g_return_val_if_fail(captive_file_slave_object->file_Handle!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
473 FileDispositionInformation_struct.DoDeleteFile=TRUE;
475 err=NtSetInformationFile(
476 captive_file_slave_object->file_Handle, /* FileHandle */
477 &file_IoStatusBlock, /* IoStatusBlock */
478 &FileDispositionInformation_struct, /* FileInformation */
479 sizeof(FileDispositionInformation_struct), /* Length */
480 FileDispositionInformation); /* FileInformationClass */
481 if (GNOME_VFS_OK!=(errvfsresult=captive_NTSTATUS_to_GnomeVFSResult(err)))
483 g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
490 /* Use 'FileNameInformationStruct' identifier instead of the logical 'FileNameInformation'
491 * to prevent override of enum member 'FileNameInformation'
493 static GnomeVFSResult FileNameInformationStruct_to_GnomeVFSFileInfo(GnomeVFSFileInfo *file_info,
494 FILE_NAME_INFORMATION *FileNameInformationStruct)
496 UNICODE_STRING FileName_UnicodeString;
498 g_return_val_if_fail(file_info!=NULL,GNOME_VFS_ERROR_GENERIC);
499 g_return_val_if_fail(FileNameInformationStruct!=NULL,GNOME_VFS_ERROR_GENERIC);
501 FileName_UnicodeString.Length=FileNameInformationStruct->FileNameLength;
502 FileName_UnicodeString.MaximumLength=FileNameInformationStruct->FileNameLength
503 +sizeof(*FileNameInformationStruct->FileName); /* 0-terminator */
505 #if 0 /* 'IoStatusBlock->Information' is sometimes weird, do not check it */
506 g_assert((gpointer)(((char *)FileNameInformationStruct->FileName)+FileName_UnicodeString.Length)
507 <=(gpointer)(((char *)FileAllInformationStruct)+IoStatusBlock->Information));
508 /* ensure we fit below '->IoStatusBlock->Information' at least without the 0-terminator */
511 FileNameInformationStruct->FileName[FileNameInformationStruct->FileNameLength
512 /sizeof(*FileNameInformationStruct->FileName)]=0; /* 0-terminate it */
513 FileName_UnicodeString.Buffer=FileNameInformationStruct->FileName;
514 file_info->name=captive_UnicodeString_to_utf8_malloc(&FileName_UnicodeString);
515 /* '->name' assumed for 'file_info->valid_fields' */
521 /* Use 'FileBasicInformationStruct' identifier instead of the logical 'FileBasicInformation'
522 * to prevent override of enum member 'FileBasicInformation'
524 static GnomeVFSResult FileBasicInformationStruct_to_GnomeVFSFileInfo(GnomeVFSFileInfo *file_info,
525 FILE_BASIC_INFORMATION *FileBasicInformationStruct)
530 /* FIXME: What is 'FILE_ATTRIBUTE_NORMAL'? */
531 switch (FileBasicInformationStruct->FileAttributes & (0
532 | FILE_ATTRIBUTE_DIRECTORY
533 | FILE_ATTRIBUTE_DEVICE)) {
534 case 0: file_info->type=GNOME_VFS_FILE_TYPE_REGULAR; break;
535 case FILE_ATTRIBUTE_DIRECTORY: file_info->type=GNOME_VFS_FILE_TYPE_DIRECTORY; break;
536 case FILE_ATTRIBUTE_DEVICE: file_info->type=GNOME_VFS_FILE_TYPE_SOCKET;
537 /* or GNOME_VFS_FILE_TYPE_CHARACTER_DEVICE or GNOME_VFS_FILE_TYPE_BLOCK_DEVICE ? */
539 default: file_info->type=GNOME_VFS_FILE_TYPE_UNKNOWN; break;
541 file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_TYPE;
543 /* we use 0600 for r/w files, 0400 for FILE_ATTRIBUTE_READONLY */
544 file_info->permissions=GNOME_VFS_PERM_USER_READ;
545 if (file_info->type==GNOME_VFS_FILE_TYPE_DIRECTORY)
546 file_info->permissions|=GNOME_VFS_PERM_USER_EXEC;
547 if (!(FileBasicInformationStruct->FileAttributes & FILE_ATTRIBUTE_READONLY))
548 file_info->permissions|=GNOME_VFS_PERM_USER_WRITE;
549 file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_PERMISSIONS;
551 if (FileBasicInformationStruct->LastAccessTime.QuadPart) { /* it may be 0 if not set */
552 errBOOLEAN=RtlTimeToSecondsSince1970(&FileBasicInformationStruct->LastAccessTime,&tmp_ULONG);
553 g_assert(errBOOLEAN==TRUE);
554 file_info->atime=tmp_ULONG;
555 file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_ATIME;
558 /* it may be 0 if not set */
559 if (FileBasicInformationStruct->LastWriteTime.QuadPart || FileBasicInformationStruct->ChangeTime.QuadPart) {
560 errBOOLEAN=RtlTimeToSecondsSince1970(
561 /* take the more recent (==bigger) time: */
562 (FileBasicInformationStruct->LastWriteTime.QuadPart > FileBasicInformationStruct->ChangeTime.QuadPart
563 ? &FileBasicInformationStruct->LastWriteTime : &FileBasicInformationStruct->ChangeTime),
565 g_assert(errBOOLEAN==TRUE);
566 file_info->mtime=tmp_ULONG;
567 file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_MTIME;
570 if (FileBasicInformationStruct->CreationTime.QuadPart) { /* it may be 0 if not set */
571 errBOOLEAN=RtlTimeToSecondsSince1970(&FileBasicInformationStruct->CreationTime,&tmp_ULONG);
572 g_assert(errBOOLEAN==TRUE);
573 file_info->ctime=tmp_ULONG;
574 file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_CTIME;
581 /* Use 'FileStandardInformationStruct' identifier instead of the logical 'FileStandardInformation'
582 * to prevent override of enum member 'FileStandardInformation'
584 static GnomeVFSResult FileStandardInformationStruct_to_GnomeVFSFileInfo(GnomeVFSFileInfo *file_info,
585 FILE_STANDARD_INFORMATION *FileStandardInformationStruct)
587 file_info->size=FileStandardInformationStruct->EndOfFile.QuadPart;
588 file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_SIZE;
590 file_info->block_count=FileStandardInformationStruct->AllocationSize.QuadPart/512;
591 file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_BLOCK_COUNT;
597 GnomeVFSResult captive_file_slave_file_info_get(CaptiveFileObject *captive_file_object,
598 GnomeVFSFileInfo *file_info)
600 CaptiveFileSlaveObject *captive_file_slave_object;
602 IO_STATUS_BLOCK file_IoStatusBlock;
603 FILE_NAME_INFORMATION *FileNameInformationStruct;
604 FILE_BASIC_INFORMATION *FileBasicInformationStruct;
605 FILE_STANDARD_INFORMATION *FileStandardInformationStruct;
606 GnomeVFSResult errvfsresult;
607 char QueryFile_buf[sizeof(FILE_NAME_INFORMATION)
608 +0x1000 /* max 'FileName' length, 255 should be enough */ * sizeof(WCHAR /* *FILE_ALL_INFORMATION.NameInformation.FileName */ )];
610 g_return_val_if_fail(CAPTIVE_FILE_SLAVE_IS_OBJECT(captive_file_object),GNOME_VFS_ERROR_BAD_PARAMETERS);
611 g_return_val_if_fail(file_info!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
613 captive_file_slave_object=CAPTIVE_FILE_SLAVE_OBJECT(captive_file_object);
615 g_return_val_if_fail(captive_file_slave_object->file_Handle!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
617 /* ntfs.sys of NT-5.1sp1 has *(FILE_BASIC_INFORMATION *)FILE_ALL_INFORMATION.BasicInformation
618 * size 0x28 although reactos includes and all the information says 0x24.
619 * fastfat.sys of NT-5.1sp1 also has the 'official' sizeof 0x24.
620 * It would be a bit of heuristic to correctly detect its expected sizeof.
623 file_info->valid_fields=0;
625 file_info->flags=GNOME_VFS_FILE_FLAGS_LOCAL;
626 file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_FLAGS;
628 /* query NameInformation */
629 FileNameInformationStruct=(void *)QueryFile_buf;
630 err=NtQueryInformationFile(
631 captive_file_slave_object->file_Handle, /* FileHandle */
632 &file_IoStatusBlock, /* IoStatusBlock */
633 (gpointer)QueryFile_buf, /* FileInformation */
634 sizeof(QueryFile_buf) /* Length */
635 -sizeof(*FileNameInformationStruct->FileName), /* reserve space for a possible 0-terminator */
636 FileNameInformation); /* FileInformationClass; =>FILE_NAME_INFORMATION */
637 if (GNOME_VFS_OK!=(errvfsresult=captive_NTSTATUS_to_GnomeVFSResult(err)))
639 g_return_val_if_fail(NT_SUCCESS(err)==NT_SUCCESS(file_IoStatusBlock.Status),GNOME_VFS_ERROR_GENERIC);
640 g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
641 errvfsresult=FileNameInformationStruct_to_GnomeVFSFileInfo(file_info,FileNameInformationStruct);
642 g_return_val_if_fail(errvfsresult==GNOME_VFS_OK,errvfsresult);
644 /* query BasicInformation */
645 FileBasicInformationStruct=(void *)QueryFile_buf;
646 err=NtQueryInformationFile(
647 captive_file_slave_object->file_Handle, /* FileHandle */
648 &file_IoStatusBlock, /* IoStatusBlock */
649 (gpointer)QueryFile_buf, /* FileInformation */
650 sizeof(QueryFile_buf), /* Length */
651 FileBasicInformation); /* FileInformationClass; =>FILE_BASIC_INFORMATION */
652 if (GNOME_VFS_OK!=(errvfsresult=captive_NTSTATUS_to_GnomeVFSResult(err)))
654 g_return_val_if_fail(NT_SUCCESS(err)==NT_SUCCESS(file_IoStatusBlock.Status),GNOME_VFS_ERROR_GENERIC);
655 g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
656 errvfsresult=FileBasicInformationStruct_to_GnomeVFSFileInfo(file_info,FileBasicInformationStruct);
657 g_return_val_if_fail(errvfsresult==GNOME_VFS_OK,errvfsresult);
659 /* query StandardInformation */
660 FileStandardInformationStruct=(void *)QueryFile_buf;
661 err=NtQueryInformationFile(
662 captive_file_slave_object->file_Handle, /* FileHandle */
663 &file_IoStatusBlock, /* IoStatusBlock */
664 (gpointer)QueryFile_buf, /* FileInformation */
665 sizeof(QueryFile_buf), /* Length */
666 FileStandardInformation); /* FileInformationClass; =>FILE_STANDARD_INFORMATION */
667 if (GNOME_VFS_OK!=(errvfsresult=captive_NTSTATUS_to_GnomeVFSResult(err)))
669 g_return_val_if_fail(NT_SUCCESS(err)==NT_SUCCESS(file_IoStatusBlock.Status),GNOME_VFS_ERROR_GENERIC);
670 g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
671 errvfsresult=FileStandardInformationStruct_to_GnomeVFSFileInfo(file_info,FileStandardInformationStruct);
672 g_return_val_if_fail(errvfsresult==GNOME_VFS_OK,errvfsresult);
679 GnomeVFSResult captive_file_slave_file_info_set(CaptiveFileObject *captive_file_object,
680 const GnomeVFSFileInfo *info,GnomeVFSSetFileInfoMask mask)
682 CaptiveFileSlaveObject *captive_file_slave_object;
684 g_return_val_if_fail(CAPTIVE_FILE_SLAVE_IS_OBJECT(captive_file_object),GNOME_VFS_ERROR_BAD_PARAMETERS);
685 g_return_val_if_fail(info!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
687 captive_file_slave_object=CAPTIVE_FILE_SLAVE_OBJECT(captive_file_object);
689 g_return_val_if_fail(captive_file_slave_object->file_Handle!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
691 if (mask & GNOME_VFS_SET_FILE_INFO_NAME) {
692 gchar *name_dirname,*name_basename;
693 UNICODE_STRING *name_UnicodeString;
694 FILE_RENAME_INFORMATION *FileRenameInformation_structp;
695 gsize FileRenameInformation_struct_len;
696 IO_STATUS_BLOCK file_IoStatusBlock;
697 NTSTATUS err=STATUS_SUCCESS; /* Prevent: ... might be used uninitialized in this function */
698 GnomeVFSResult errvfsresult;
700 /* non-existing dirname assertion */
701 name_dirname=g_path_get_dirname(info->name);
703 g_assert_not_reached();
704 errvfsresult=GNOME_VFS_ERROR_BAD_PARAMETERS;
708 /* fully-matching basename assertion */
709 name_basename=g_path_get_basename(info->name);
710 if (strcmp(name_basename,info->name)) {
711 g_assert_not_reached();
712 errvfsresult=GNOME_VFS_ERROR_BAD_PARAMETERS;
713 goto err_free_name_dirname;
716 name_UnicodeString=captive_utf8_to_UnicodeString_alloca(info->name);
717 FileRenameInformation_struct_len=sizeof(*FileRenameInformation_structp)
718 +name_UnicodeString->MaximumLength; /* ==Length+(0-terminator); is the terminator needed? */
720 FileRenameInformation_structp=g_alloca(FileRenameInformation_struct_len);
721 FileRenameInformation_structp->Replace=FALSE;
722 FileRenameInformation_structp->RootDir=NULL; /* we do 'simple rename' here */
723 FileRenameInformation_structp->FileNameLength=name_UnicodeString->Length;
724 memcpy(FileRenameInformation_structp->FileName,name_UnicodeString->Buffer,
725 name_UnicodeString->MaximumLength); /* ==Length+(0-terminator); is the terminator needed? */
727 err=NtSetInformationFile(
728 captive_file_slave_object->file_Handle, /* FileHandle */
729 &file_IoStatusBlock, /* IoStatusBlock */
730 FileRenameInformation_structp, /* FileInformation */
731 FileRenameInformation_struct_len, /* Length */
732 FileRenameInformation); /* FileInformationClass */
733 if (GNOME_VFS_OK!=(errvfsresult=captive_NTSTATUS_to_GnomeVFSResult(err)))
734 goto err_free_name_basename;
736 err_free_name_basename:
737 g_free(name_basename);
738 err_free_name_dirname:
739 g_free(name_dirname);
742 if (errvfsresult!=GNOME_VFS_OK)
744 g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
747 if (mask & (GNOME_VFS_SET_FILE_INFO_PERMISSIONS | GNOME_VFS_SET_FILE_INFO_TIME)) {
748 char FileBasicInformation_buf[sizeof(FILE_BASIC_INFORMATION)+4];
749 FILE_BASIC_INFORMATION *FileBasicInformationp=(FILE_BASIC_INFORMATION *)FileBasicInformation_buf;
750 IO_STATUS_BLOCK file_IoStatusBlock;
753 /* FIXME: Everywhere is is the declaration with 4xLARGE_INTEGER+1xULONG==36 bytes
754 * but the precompiled ext2fsd.sys wants 40 bytes - why?
755 * The same case applies to ntfs.sys of NT-5.1sp1.
757 g_assert(sizeof(FILE_BASIC_INFORMATION)==36);
758 g_assert(sizeof(FileBasicInformation_buf)==40);
759 err=NtQueryInformationFile(
760 captive_file_slave_object->file_Handle, /* FileHandle */
761 &file_IoStatusBlock, /* IoStatusBlock */
762 FileBasicInformation_buf, /* FileInformation */
763 sizeof(FileBasicInformation_buf), /* Length */
764 FileBasicInformation); /* FileInformationClass */
765 g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
767 if (mask & GNOME_VFS_SET_FILE_INFO_PERMISSIONS) {
768 FileBasicInformationp->FileAttributes&=~FILE_ATTRIBUTE_READONLY;
769 g_assert(info->valid_fields & GNOME_VFS_FILE_INFO_FIELDS_PERMISSIONS);
770 if (!(info->permissions&0200))
771 FileBasicInformationp->FileAttributes|=FILE_ATTRIBUTE_READONLY;
774 if (mask & GNOME_VFS_SET_FILE_INFO_TIME) {
775 g_assert(info->valid_fields & (0
776 | GNOME_VFS_FILE_INFO_FIELDS_ATIME
777 | GNOME_VFS_FILE_INFO_FIELDS_MTIME
778 | GNOME_VFS_FILE_INFO_FIELDS_CTIME));
779 if (info->valid_fields&GNOME_VFS_FILE_INFO_FIELDS_ATIME) {
780 RtlSecondsSince1970ToTime(
781 info->atime, /* SecondsSince1970 */
782 &FileBasicInformationp->LastAccessTime); /* Time */
784 if (info->valid_fields&GNOME_VFS_FILE_INFO_FIELDS_MTIME) {
785 RtlSecondsSince1970ToTime(
786 info->mtime, /* SecondsSince1970 */
787 &FileBasicInformationp->LastWriteTime); /* Time */
788 FileBasicInformationp->ChangeTime=FileBasicInformationp->LastWriteTime;
790 if (info->valid_fields&GNOME_VFS_FILE_INFO_FIELDS_CTIME) {
791 RtlSecondsSince1970ToTime(
792 info->ctime, /* SecondsSince1970 */
793 &FileBasicInformationp->CreationTime); /* Time */
797 err=NtSetInformationFile(
798 captive_file_slave_object->file_Handle, /* FileHandle */
799 &file_IoStatusBlock, /* IoStatusBlock */
800 FileBasicInformation_buf, /* FileInformation */
801 sizeof(FileBasicInformation_buf), /* Length */
802 FileBasicInformation); /* FileInformationClass */
803 g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
806 if (mask & GNOME_VFS_SET_FILE_INFO_OWNER) {
807 /* FIXME: g_assert(info->valid_fields & ???); */
808 /* owner ignored for W32 */
816 GnomeVFSResult captive_file_slave_truncate(CaptiveFileObject *captive_file_object,GnomeVFSFileSize file_size)
818 CaptiveFileSlaveObject *captive_file_slave_object;
820 FILE_END_OF_FILE_INFORMATION FileEndOfFileInformation_struct;
821 IO_STATUS_BLOCK file_IoStatusBlock;
822 GnomeVFSResult errvfsresult;
824 g_return_val_if_fail(CAPTIVE_FILE_SLAVE_IS_OBJECT(captive_file_object),GNOME_VFS_ERROR_BAD_PARAMETERS);
826 captive_file_slave_object=CAPTIVE_FILE_SLAVE_OBJECT(captive_file_object);
828 g_return_val_if_fail(captive_file_slave_object->file_Handle!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
830 FileEndOfFileInformation_struct.EndOfFile.QuadPart=file_size;
832 err=NtSetInformationFile(
833 captive_file_slave_object->file_Handle, /* FileHandle */
834 &file_IoStatusBlock, /* IoStatusBlock */
835 &FileEndOfFileInformation_struct, /* FileInformation */
836 sizeof(FileEndOfFileInformation_struct), /* Length */
837 FileEndOfFileInformation); /* FileInformationClass */
838 if (GNOME_VFS_OK!=(errvfsresult=captive_NTSTATUS_to_GnomeVFSResult(err)))
840 g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
847 GnomeVFSResult captive_file_slave_move
848 (CaptiveFileObject *captive_file_object_old,const gchar *pathname_new,gboolean force_replace)
850 CaptiveFileSlaveObject *captive_file_slave_object_old;
852 FILE_RENAME_INFORMATION *FileRenameInformation_structp;
853 IO_STATUS_BLOCK file_IoStatusBlock;
854 GnomeVFSResult errvfsresult;
855 OBJECT_ATTRIBUTES pathname_new_ObjectAttributes;
857 g_return_val_if_fail(CAPTIVE_FILE_SLAVE_IS_OBJECT(captive_file_object_old),GNOME_VFS_ERROR_BAD_PARAMETERS);
858 g_return_val_if_fail(pathname_new!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
860 captive_file_slave_object_old=CAPTIVE_FILE_SLAVE_OBJECT(captive_file_object_old);
862 g_return_val_if_fail(captive_file_slave_object_old->file_Handle!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
864 errvfsresult=captive_ObjectAttributes_init(pathname_new,&pathname_new_ObjectAttributes);
865 g_return_val_if_fail(errvfsresult==GNOME_VFS_OK,errvfsresult);
867 FileRenameInformation_structp=
868 g_alloca(sizeof(*FileRenameInformation_structp)+pathname_new_ObjectAttributes.ObjectName->MaximumLength);
869 FileRenameInformation_structp->Replace=force_replace;
870 FileRenameInformation_structp->RootDir=0; /* AFAIK never set by orig W32 */
871 FileRenameInformation_structp->FileNameLength=pathname_new_ObjectAttributes.ObjectName->Length;
872 memcpy(FileRenameInformation_structp->FileName,pathname_new_ObjectAttributes.ObjectName->Buffer,
873 pathname_new_ObjectAttributes.ObjectName->MaximumLength);
875 err=NtSetInformationFile(
876 captive_file_slave_object_old->file_Handle, /* FileHandle */
877 &file_IoStatusBlock, /* IoStatusBlock */
878 FileRenameInformation_structp, /* FileInformation */
879 sizeof(*FileRenameInformation_structp)+pathname_new_ObjectAttributes.ObjectName->MaximumLength, /* Length */
880 FileRenameInformation); /* FileInformationClass */
881 if (GNOME_VFS_OK!=(errvfsresult=captive_NTSTATUS_to_GnomeVFSResult(err)))
882 goto err_free_ObjectAttributes;
883 g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
885 errvfsresult=GNOME_VFS_OK;
887 err_free_ObjectAttributes:
888 g_free(pathname_new_ObjectAttributes.ObjectName); /* left from captive_file_slave_uri_parent_init() */