/
platform.fs.cpp
1818 lines (1482 loc) · 54.6 KB
/
platform.fs.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
platform.fs.cpp
*/
/*
Copyright © 2017 Far Group
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. The name of the authors may not be used to endorse or promote products
derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "headers.hpp"
#pragma hdrstop
#include "platform.fs.hpp"
#include "ctrlobj.hpp"
#include "cvtname.hpp"
#include "datetime.hpp"
#include "drivemix.hpp"
#include "elevation.hpp"
#include "flink.hpp"
#include "imports.hpp"
#include "pathmix.hpp"
#include "plugins.hpp"
#include "string_utils.hpp"
#include "strmix.hpp"
namespace
{
class i_find_file_handle_impl
{
public:
virtual ~i_find_file_handle_impl() = 0;
};
i_find_file_handle_impl::~i_find_file_handle_impl() = default;
class far_find_file_handle_impl: public i_find_file_handle_impl
{
public:
os::fs::file Object;
block_ptr<BYTE> BufferBase;
block_ptr<BYTE> Buffer2;
ULONG NextOffset{};
bool Extended{};
bool ReadDone{};
};
class os_find_file_handle_impl: public i_find_file_handle_impl, public os::fs::find_handle
{
using os::fs::find_handle::find_handle;
};
}
namespace os::fs
{
namespace detail
{
void find_handle_closer::operator()(HANDLE Handle) const
{
FindClose(Handle);
}
void find_file_handle_closer::operator()(HANDLE Handle) const
{
delete static_cast<i_find_file_handle_impl*>(Handle);
}
void find_volume_handle_closer::operator()(HANDLE Handle) const
{
FindVolumeClose(Handle);
}
void find_notification_handle_closer::operator()(HANDLE Handle) const
{
FindCloseChangeNotification(Handle);
}
}
bool is_standard_drive_letter(wchar_t Letter)
{
return InRange(L'A', upper(Letter), L'Z');
}
int get_drive_number(wchar_t Letter)
{
return upper(Letter) - L'A';
}
string get_drive(wchar_t Letter)
{
return { Letter, L':' };
}
string get_root_directory(wchar_t Letter)
{
return { Letter, L':', L'\\' };
}
//-------------------------------------------------------------------------
enum_drives::enum_drives(drives_set Drives):
m_Drives(Drives)
{
}
bool enum_drives::get(size_t Index, wchar_t& Value) const
{
if (!Index)
m_CurrentIndex = 0;
while (m_CurrentIndex != m_Drives.size() && !m_Drives[m_CurrentIndex])
++m_CurrentIndex;
if (m_CurrentIndex == m_Drives.size())
return false;
Value = static_cast<wchar_t>(L'A' + m_CurrentIndex);
++m_CurrentIndex;
return true;
}
//-------------------------------------------------------------------------
static string enum_files_prepare(const string_view& Object)
{
auto PreparedObject = NTPath(Object);
auto Root = false;
const auto Type = ParsePath(PreparedObject, nullptr, &Root);
if (Root && (Type == root_type::drive_letter || Type == root_type::unc_drive_letter || Type == root_type::volume))
{
AddEndSlash(PreparedObject);
}
else
{
DeleteEndSlash(PreparedObject);
}
return PreparedObject;
}
enum_files::enum_files(const string_view& Object, bool ScanSymlink):
m_Object(enum_files_prepare(Object)),
m_ScanSymlink(ScanSymlink)
{
}
static void DirectoryInfoToFindData(const FILE_ID_BOTH_DIR_INFORMATION& DirectoryInfo, find_data& FindData, bool IsExtended)
{
FindData.dwFileAttributes = DirectoryInfo.FileAttributes;
FindData.CreationTime = time_point(duration(DirectoryInfo.CreationTime.QuadPart));
FindData.LastAccessTime = time_point(duration(DirectoryInfo.LastAccessTime.QuadPart));
FindData.LastWriteTime = time_point(duration(DirectoryInfo.LastWriteTime.QuadPart));
FindData.ChangeTime = time_point(duration(DirectoryInfo.ChangeTime.QuadPart));
FindData.nFileSize = DirectoryInfo.EndOfFile.QuadPart;
FindData.nAllocationSize = DirectoryInfo.AllocationSize.QuadPart;
FindData.dwReserved0 = FindData.dwFileAttributes&FILE_ATTRIBUTE_REPARSE_POINT? DirectoryInfo.EaSize : 0;
const auto& CopyNames = [&FindData](const auto& DirInfo)
{
FindData.strFileName.assign(DirInfo.FileName, DirInfo.FileNameLength / sizeof(wchar_t));
FindData.strAlternateFileName.assign(DirInfo.ShortName, DirInfo.ShortNameLength / sizeof(wchar_t));
};
if (IsExtended)
{
FindData.FileId = DirectoryInfo.FileId.QuadPart;
CopyNames(DirectoryInfo);
}
else
{
FindData.FileId = 0;
CopyNames(reinterpret_cast<const FILE_BOTH_DIR_INFORMATION&>(DirectoryInfo));
}
const auto& RemoveTrailingZeros = [](string& Where)
{
const auto Pos = Where.find_last_not_of(L'\0');
Pos != string::npos? Where.resize(Pos + 1) : Where.clear();
};
// MSDN verse 2.4.17:
// "When working with this field, use FileNameLength to determine the length of the file name
// rather than assuming the presence of a trailing null delimiter."
// Some buggy implementations (e. g. ms sharepoint, rdesktop) set the length incorrectly
// (e. g. including the terminating \0 or as ((number of bytes in the source string) * 2) when source is in UTF-8),
// so instead of, say, "name" (4) they return "name\0\0\0\0" (8).
// Generally speaking, it's their own problems and we shall use it as is, as per the verse above.
// However, most of the applications use FindFirstFile API, which copies this string
// to the fixed-size buffer WIN32_FIND_DATA.cFileName, leaving the burden of finding its length
// to the application itself, which, by coincidence, does it correctly, effectively masking the initial error.
// So people come to us and claim that Far isn't working properly while other programs are fine.
RemoveTrailingZeros(FindData.strFileName);
RemoveTrailingZeros(FindData.strAlternateFileName);
// Some other buggy implementations just set the first char of AlternateFileName to '\0' to make it "empty", leaving rubbish in others. Double facepalm.
if (!FindData.strAlternateFileName.empty() && FindData.strAlternateFileName.front() == L'\0')
FindData.strAlternateFileName.clear();
}
static find_file_handle FindFirstFileInternal(const string& Name, find_data& FindData)
{
if (Name.empty() || IsSlash(Name.back()))
return nullptr;
auto Handle = std::make_unique<far_find_file_handle_impl>();
auto strDirectory(Name);
CutToSlash(strDirectory);
const auto& OpenDirectory = [&]
{
return Handle->Object.Open(strDirectory, FILE_LIST_DIRECTORY, FILE_SHARE_READ | FILE_SHARE_WRITE, nullptr, OPEN_EXISTING);
};
if (!OpenDirectory())
{
// fix error code if we are looking for FILE(S) in a non-existent directory, not for a directory itself
if (GetLastError() == ERROR_FILE_NOT_FOUND && !PointToName(Name).empty())
{
SetLastError(ERROR_PATH_NOT_FOUND);
}
return nullptr;
}
// for network paths buffer size must be <= 64k
Handle->BufferBase.reset(0x10000);
const auto NamePart = PointToName(Name);
Handle->Extended = true;
bool QueryResult = Handle->Object.NtQueryDirectoryFile(Handle->BufferBase.get(), Handle->BufferBase.size(), FileIdBothDirectoryInformation, false, null_terminated(NamePart).data(), true);
if (QueryResult) // try next read immediately to avoid M#2128 bug
{
block_ptr<BYTE> Buffer2(Handle->BufferBase.size());
if (Handle->Object.NtQueryDirectoryFile(Buffer2.get(), Buffer2.size(), FileIdBothDirectoryInformation, false, null_terminated(NamePart).data(), false))
{
Handle->Buffer2 = std::move(Buffer2);
}
else
{
if (GetLastError() != ERROR_INVALID_LEVEL)
Handle->ReadDone = true;
else
QueryResult = false;
}
}
if (!QueryResult)
{
Handle->Extended = false;
// recreate the handle to avoid weird bugs with some network emulators
Handle->Object.Close();
if (OpenDirectory())
{
QueryResult = Handle->Object.NtQueryDirectoryFile(Handle->BufferBase.get(), Handle->BufferBase.size(), FileBothDirectoryInformation, false, null_terminated(NamePart).data(), true);
}
}
if (!QueryResult)
return nullptr;
const auto DirectoryInfo = reinterpret_cast<const FILE_ID_BOTH_DIR_INFORMATION*>(Handle->BufferBase.get());
DirectoryInfoToFindData(*DirectoryInfo, FindData, Handle->Extended);
Handle->NextOffset = DirectoryInfo->NextEntryOffset;
return find_file_handle(Handle.release());
}
static bool FindNextFileInternal(const find_file_handle& Find, find_data& FindData)
{
bool Result = false;
const auto Handle = static_cast<far_find_file_handle_impl*>(Find.native_handle());
bool Status = true, set_errcode = true;
auto DirectoryInfo = reinterpret_cast<const FILE_ID_BOTH_DIR_INFORMATION*>(Handle->BufferBase.get());
if (Handle->NextOffset)
{
DirectoryInfo = reinterpret_cast<const FILE_ID_BOTH_DIR_INFORMATION*>(reinterpret_cast<const char*>(DirectoryInfo) + Handle->NextOffset);
}
else
{
if (Handle->ReadDone)
{
Status = false;
}
else
{
if (Handle->Buffer2)
{
Handle->BufferBase.reset();
using std::swap;
swap(Handle->BufferBase, Handle->Buffer2);
DirectoryInfo = reinterpret_cast<const FILE_ID_BOTH_DIR_INFORMATION*>(Handle->BufferBase.get());
}
else
{
Status = Handle->Object.NtQueryDirectoryFile(Handle->BufferBase.get(), Handle->BufferBase.size(), Handle->Extended? FileIdBothDirectoryInformation : FileBothDirectoryInformation, false, nullptr, false);
set_errcode = false;
}
}
}
if (Status)
{
DirectoryInfoToFindData(*DirectoryInfo, FindData, Handle->Extended);
Handle->NextOffset = DirectoryInfo->NextEntryOffset? Handle->NextOffset + DirectoryInfo->NextEntryOffset : 0;
Result = true;
}
if (set_errcode)
SetLastError(Result? ERROR_SUCCESS : ERROR_NO_MORE_FILES);
return Result;
}
bool enum_files::get(size_t index, find_data& Value) const
{
if (!index)
{
// temporarily disable elevation to try the requested name first
{
SCOPED_ACTION(elevation::suppress);
m_Handle = FindFirstFileInternal(m_Object, Value);
}
if (!m_Handle && GetLastError() == ERROR_ACCESS_DENIED)
{
if (m_ScanSymlink)
{
auto strReal = m_Object;
// only links in the path should be processed, not the object name itself
CutToSlash(strReal);
strReal = ConvertNameToReal(strReal);
AddEndSlash(strReal);
append(strReal, PointToName(m_Object));
strReal = NTPath(strReal);
m_Handle = FindFirstFileInternal(strReal, Value);
}
if (!m_Handle && ElevationRequired(ELEVATION_READ_REQUEST))
{
m_Handle = FindFirstFileInternal(m_Object, Value);
}
}
if (!m_Handle)
return false;
}
else
{
if (!FindNextFileInternal(m_Handle, Value))
return false;
}
// skip ".." & "."
if (Value.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY &&
Value.strFileName[0] == L'.' && ((Value.strFileName.size() == 2 && Value.strFileName[1] == L'.') || Value.strFileName.size() == 1) &&
// These "virtual" folders either don't have an SFN at all or it's the same as LFN:
(Value.strAlternateFileName.empty() || Value.strAlternateFileName == Value.strFileName))
{
// index is not important here, anything but 0 is fine
return get(1, Value);
}
return true;
}
//-------------------------------------------------------------------------
find_handle FindFirstFileName(const string_view& FileName, DWORD Flags, string& LinkName)
{
NTPath NtFileName(FileName);
find_handle Handle;
os::detail::ApiDynamicStringReceiver(LinkName, [&](wchar_t* Buffer, size_t Size)
{
auto BufferSize = static_cast<DWORD>(Size);
Handle.reset(Imports().FindFirstFileNameW(NtFileName.data(), Flags, &BufferSize, Buffer));
if (Handle)
// FindFirstFileNameW always includes terminating \0 in the returned size
return BufferSize - 1;
return GetLastError() == ERROR_MORE_DATA? BufferSize : 0;
});
return Handle;
}
bool FindNextFileName(const find_handle& hFindStream, string& LinkName)
{
return os::detail::ApiDynamicStringReceiver(LinkName, [&](wchar_t* Buffer, size_t Size)
{
auto BufferSize = static_cast<DWORD>(Size);
if (Imports().FindNextFileNameW(hFindStream.native_handle(), &BufferSize, Buffer))
// FindNextFileNameW always includes terminating \0 in the returned size
return BufferSize - 1;
return GetLastError() == ERROR_MORE_DATA? BufferSize : 0;
});
}
enum_names::enum_names(const string_view& Object):
m_Object(make_string(Object))
{
}
bool enum_names::get(size_t Index, string& Value) const
{
if (!Index)
{
m_Handle = FindFirstFileName(m_Object, 0, Value);
return m_Handle != nullptr;
}
return FindNextFileName(m_Handle, Value);
}
//-------------------------------------------------------------------------
static bool FileStreamInformationToFindStreamData(const FILE_STREAM_INFORMATION& StreamInfo, WIN32_FIND_STREAM_DATA& StreamData)
{
const auto Length = StreamInfo.StreamNameLength / sizeof(wchar_t);
if (!Length || Length >= std::size(StreamData.cStreamName))
return false;
*std::copy_n(std::cbegin(StreamInfo.StreamName), Length, StreamData.cStreamName) = L'\0';
StreamData.StreamSize = StreamInfo.StreamSize;
return true;
}
find_file_handle FindFirstStream(const string_view& FileName, STREAM_INFO_LEVELS InfoLevel, void* FindStreamData, DWORD Flags)
{
if (Imports().FindFirstStreamW && Imports().FindNextStreamW)
{
os_find_file_handle_impl Handle(Imports().FindFirstStreamW(NTPath(FileName).data(), InfoLevel, FindStreamData, Flags));
return find_file_handle(Handle? std::make_unique<os_find_file_handle_impl>(Handle.release()).release() : nullptr);
}
if (InfoLevel != FindStreamInfoStandard)
return nullptr;
auto Handle = std::make_unique<far_find_file_handle_impl>();
if (!Handle->Object.Open(FileName, 0, FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE, nullptr, OPEN_EXISTING))
return nullptr;
// for network paths buffer size must be <= 64k
// we double it in a first loop, so starting value is 32k
size_t BufferSize = 0x8000;
NTSTATUS Result = STATUS_SEVERITY_ERROR;
do
{
BufferSize *= 2;
Handle->BufferBase.reset(BufferSize);
// sometimes for directories NtQueryInformationFile returns STATUS_SUCCESS but doesn't fill the buffer
const auto StreamInfo = reinterpret_cast<FILE_STREAM_INFORMATION*>(Handle->BufferBase.get());
StreamInfo->StreamNameLength = 0;
Handle->Object.NtQueryInformationFile(Handle->BufferBase.get(), Handle->BufferBase.size(), FileStreamInformation, &Result);
}
while (Result == STATUS_BUFFER_OVERFLOW || Result == STATUS_BUFFER_TOO_SMALL);
if (Result != STATUS_SUCCESS)
return nullptr;
const auto StreamInfo = reinterpret_cast<const FILE_STREAM_INFORMATION*>(Handle->BufferBase.get());
Handle->NextOffset = StreamInfo->NextEntryOffset;
const auto StreamData = static_cast<WIN32_FIND_STREAM_DATA*>(FindStreamData);
if (!FileStreamInformationToFindStreamData(*StreamInfo, *StreamData))
return nullptr;
return find_file_handle(Handle.release());
}
bool FindNextStream(const find_file_handle& hFindStream, void* FindStreamData)
{
if (Imports().FindFirstStreamW && Imports().FindNextStreamW)
{
return Imports().FindNextStreamW(static_cast<os_find_file_handle_impl*>(hFindStream.native_handle())->native_handle(), FindStreamData) != FALSE;
}
const auto Handle = static_cast<far_find_file_handle_impl*>(hFindStream.native_handle());
if (!Handle->NextOffset)
return false;
const auto StreamInfo = reinterpret_cast<const FILE_STREAM_INFORMATION*>(Handle->BufferBase.get() + Handle->NextOffset);
Handle->NextOffset = StreamInfo->NextEntryOffset? Handle->NextOffset + StreamInfo->NextEntryOffset : 0;
const auto StreamData = static_cast<WIN32_FIND_STREAM_DATA*>(FindStreamData);
return FileStreamInformationToFindStreamData(*StreamInfo, *StreamData);
}
enum_streams::enum_streams(const string_view& Object):
m_Object(make_string(Object))
{
}
bool enum_streams::get(size_t Index, WIN32_FIND_STREAM_DATA& Value) const
{
if (!Index)
{
m_Handle = FindFirstStream(m_Object, FindStreamInfoStandard, &Value, 0);
return m_Handle != nullptr;
}
return FindNextStream(m_Handle, &Value);
}
//-------------------------------------------------------------------------
enum_volumes::enum_volumes() = default;
bool enum_volumes::get(size_t Index, string& Value) const
{
wchar_t VolumeName[50];
if (!Index)
{
m_Handle.reset(FindFirstVolume(VolumeName, static_cast<DWORD>(std::size(VolumeName))));
if (!m_Handle)
{
return false;
}
}
else
{
if (!FindNextVolume(m_Handle.native_handle(), VolumeName, static_cast<DWORD>(std::size(VolumeName))))
{
return false;
}
}
Value = VolumeName;
return true;
}
//-------------------------------------------------------------------------
bool file::operator!() const noexcept
{
return !m_Handle;
}
bool file::Open(const string_view& Object, DWORD DesiredAccess, DWORD ShareMode, SECURITY_ATTRIBUTES* SecurityAttributes, DWORD CreationDistribution, DWORD FlagsAndAttributes, const file* TemplateFile, bool ForceElevation)
{
assert(!m_Handle);
m_Pointer = 0;
m_NeedSyncPointer = false;
const auto TemplateFileHandle = TemplateFile? TemplateFile->m_Handle.native_handle() : nullptr;
m_Handle = create_file(Object, DesiredAccess, ShareMode, SecurityAttributes, CreationDistribution, FlagsAndAttributes, TemplateFileHandle, ForceElevation);
if (!m_Handle)
{
m_Name.clear();
m_ShareMode = 0;
return false;
}
m_Name = make_string(Object);
m_ShareMode = ShareMode;
return true;
}
bool file::Read(void* Buffer, size_t NumberOfBytesToRead, size_t& NumberOfBytesRead) const
{
assert(NumberOfBytesToRead <= std::numeric_limits<DWORD>::max());
SyncPointer();
NumberOfBytesRead = 0;
DWORD BytesRead = 0;
if (!ReadFile(m_Handle.native_handle(), Buffer, static_cast<DWORD>(NumberOfBytesToRead), &BytesRead, nullptr))
return false;
NumberOfBytesRead = BytesRead;
m_Pointer += NumberOfBytesRead;
return true;
}
bool file::Write(const void* Buffer, size_t NumberOfBytesToWrite) const
{
assert(NumberOfBytesToWrite <= std::numeric_limits<DWORD>::max());
SyncPointer();
DWORD BytesWritten = 0;
if (!WriteFile(m_Handle.native_handle(), Buffer, static_cast<DWORD>(NumberOfBytesToWrite), &BytesWritten, nullptr))
return false;
m_Pointer += BytesWritten;
return true;
}
unsigned long long file::GetPointer() const
{
return m_Pointer;
}
bool file::SetPointer(long long DistanceToMove, unsigned long long* NewFilePointer, DWORD MoveMethod) const
{
const auto OldPointer = m_Pointer;
switch (MoveMethod)
{
case FILE_BEGIN:
m_Pointer = DistanceToMove;
break;
case FILE_CURRENT:
m_Pointer += DistanceToMove;
break;
case FILE_END:
{
unsigned long long Size = 0;
GetSize(Size);
m_Pointer = Size + DistanceToMove;
}
break;
}
if (OldPointer != m_Pointer)
{
m_NeedSyncPointer = true;
}
if (NewFilePointer)
{
*NewFilePointer = m_Pointer;
}
return true;
}
bool file::SetEnd()
{
SyncPointer();
bool ok = SetEndOfFile(m_Handle.native_handle()) != FALSE;
if (!ok && !m_Name.empty() && GetLastError() == ERROR_INVALID_PARAMETER) // OSX buggy SMB workaround
{
const auto fsize = GetPointer();
Close();
if (Open(m_Name, GENERIC_WRITE, m_ShareMode, nullptr, OPEN_EXISTING, 0))
{
SetPointer(fsize, nullptr, FILE_BEGIN);
SyncPointer();
ok = SetEndOfFile(m_Handle.native_handle()) != FALSE;
}
}
return ok;
}
bool file::GetTime(time_point* CreationTime, time_point* LastAccessTime, time_point* LastWriteTime, time_point* ChangeTime) const
{
FILE_BASIC_INFORMATION fbi;
if (!NtQueryInformationFile(&fbi, sizeof fbi, FileBasicInformation))
return false;
if (CreationTime)
*CreationTime = time_point(duration(fbi.CreationTime.QuadPart));
if (LastAccessTime)
*LastAccessTime = time_point(duration(fbi.LastAccessTime.QuadPart));
if (LastWriteTime)
*LastWriteTime = time_point(duration(fbi.LastWriteTime.QuadPart));
if (ChangeTime)
*ChangeTime = time_point(duration(fbi.ChangeTime.QuadPart));
return true;
}
bool file::SetTime(const time_point* CreationTime, const time_point* LastAccessTime, const time_point* LastWriteTime, const time_point* ChangeTime) const
{
FILE_BASIC_INFORMATION fbi{};
if (CreationTime)
fbi.CreationTime.QuadPart = CreationTime->time_since_epoch().count();
if (LastAccessTime)
fbi.LastAccessTime.QuadPart = LastAccessTime->time_since_epoch().count();
if (LastWriteTime)
fbi.LastWriteTime.QuadPart = LastWriteTime->time_since_epoch().count();
if (ChangeTime)
fbi.ChangeTime.QuadPart = ChangeTime->time_since_epoch().count();
IO_STATUS_BLOCK IoStatusBlock;
const auto Status = Imports().NtSetInformationFile(m_Handle.native_handle(), &IoStatusBlock, &fbi, sizeof fbi, FileBasicInformation);
::SetLastError(Imports().RtlNtStatusToDosError(Status));
return Status == STATUS_SUCCESS;
}
bool file::GetSize(unsigned long long& Size) const
{
if (::GetFileSizeEx(m_Handle.native_handle(), reinterpret_cast<PLARGE_INTEGER>(&Size)))
return true;
GET_LENGTH_INFORMATION gli;
DWORD BytesReturned;
if (!IoControl(IOCTL_DISK_GET_LENGTH_INFO, nullptr, 0, &gli, sizeof(gli), &BytesReturned))
return false;
Size = gli.Length.QuadPart;
return true;
}
bool file::FlushBuffers() const
{
return FlushFileBuffers(m_Handle.native_handle()) != FALSE;
}
bool file::GetInformation(BY_HANDLE_FILE_INFORMATION& info) const
{
return GetFileInformationByHandle(m_Handle.native_handle(), &info) != FALSE;
}
bool file::IoControl(DWORD IoControlCode, void* InBuffer, DWORD InBufferSize, void* OutBuffer, DWORD OutBufferSize, DWORD* BytesReturned, OVERLAPPED* Overlapped) const
{
return ::DeviceIoControl(m_Handle.native_handle(), IoControlCode, InBuffer, InBufferSize, OutBuffer, OutBufferSize, BytesReturned, Overlapped) != FALSE;
}
bool file::GetStorageDependencyInformation(GET_STORAGE_DEPENDENCY_FLAG Flags, ULONG StorageDependencyInfoSize, PSTORAGE_DEPENDENCY_INFO StorageDependencyInfo, PULONG SizeUsed) const
{
DWORD Result = Imports().GetStorageDependencyInformation(m_Handle.native_handle(), Flags, StorageDependencyInfoSize, StorageDependencyInfo, SizeUsed);
SetLastError(Result);
return Result == ERROR_SUCCESS;
}
bool file::NtQueryDirectoryFile(void* FileInformation, size_t Length, FILE_INFORMATION_CLASS FileInformationClass, bool ReturnSingleEntry, const wchar_t* FileName, bool RestartScan, NTSTATUS* Status) const
{
IO_STATUS_BLOCK IoStatusBlock;
PUNICODE_STRING pNameString = nullptr;
UNICODE_STRING NameString;
if (FileName && *FileName)
{
NameString.Buffer = const_cast<LPWSTR>(FileName);
NameString.Length = static_cast<USHORT>(wcslen(FileName) * sizeof(WCHAR));
NameString.MaximumLength = NameString.Length;
pNameString = &NameString;
}
const auto di = reinterpret_cast<FILE_ID_BOTH_DIR_INFORMATION*>(FileInformation);
di->NextEntryOffset = 0xffffffffUL;
NTSTATUS Result = Imports().NtQueryDirectoryFile(m_Handle.native_handle(), nullptr, nullptr, nullptr, &IoStatusBlock, FileInformation, static_cast<ULONG>(Length), FileInformationClass, ReturnSingleEntry, pNameString, RestartScan);
SetLastError(Imports().RtlNtStatusToDosError(Result));
if (Status)
{
*Status = Result;
}
return (Result == STATUS_SUCCESS) && (di->NextEntryOffset != 0xffffffffUL);
}
bool file::NtQueryInformationFile(void* FileInformation, size_t Length, FILE_INFORMATION_CLASS FileInformationClass, NTSTATUS* Status) const
{
IO_STATUS_BLOCK IoStatusBlock;
NTSTATUS Result = Imports().NtQueryInformationFile(m_Handle.native_handle(), &IoStatusBlock, FileInformation, static_cast<ULONG>(Length), FileInformationClass);
SetLastError(Imports().RtlNtStatusToDosError(Result));
if (Status)
{
*Status = Result;
}
return Result == STATUS_SUCCESS;
}
static bool GetObjectName(HANDLE hFile, string& ObjectName)
{
block_ptr<OBJECT_NAME_INFORMATION> oni(NT_MAX_PATH);
ULONG ReturnLength;
const auto& QueryObject = [&]
{
return Imports().NtQueryObject(hFile, ObjectNameInformation, oni.get(), static_cast<unsigned long>(oni.size()), &ReturnLength);
};
auto Result = QueryObject();
if (Result == STATUS_BUFFER_OVERFLOW || Result == STATUS_BUFFER_TOO_SMALL)
{
oni.reset(ReturnLength);
Result = QueryObject();
}
if (Result != STATUS_SUCCESS)
return false;
ObjectName.assign(oni->Name.Buffer, oni->Name.Length / sizeof(WCHAR));
return true;
}
static int MatchNtPathRoot(const string& NtPath, const string& DeviceName)
{
string TargetPath;
if (!os::fs::QueryDosDevice(DeviceName, TargetPath))
return 0;
if (PathStartsWith(NtPath, TargetPath))
return static_cast<int>(TargetPath.size());
// path could be an Object Manager symlink, try to resolve
UNICODE_STRING ObjName;
ObjName.Length = ObjName.MaximumLength = static_cast<USHORT>(TargetPath.size() * sizeof(wchar_t));
ObjName.Buffer = UNSAFE_CSTR(TargetPath);
OBJECT_ATTRIBUTES ObjAttrs;
InitializeObjectAttributes(&ObjAttrs, &ObjName, 0, nullptr, nullptr);
HANDLE hSymLink;
if (Imports().NtOpenSymbolicLinkObject(&hSymLink, GENERIC_READ, &ObjAttrs) != STATUS_SUCCESS)
return 0;
SCOPE_EXIT{ Imports().NtClose(hSymLink); };
ULONG BufSize = 32767;
wchar_t_ptr Buffer(BufSize);
UNICODE_STRING LinkTarget;
LinkTarget.MaximumLength = static_cast<USHORT>(BufSize * sizeof(wchar_t));
LinkTarget.Buffer = Buffer.get();
if (Imports().NtQuerySymbolicLinkObject(hSymLink, &LinkTarget, nullptr) != STATUS_SUCCESS)
return 0;
TargetPath.assign(LinkTarget.Buffer, LinkTarget.Length / sizeof(wchar_t));
if (PathStartsWith(NtPath, TargetPath))
return static_cast<int>(TargetPath.size());
return 0;
}
static bool internalNtQueryGetFinalPathNameByHandle(HANDLE hFile, string& FinalFilePath)
{
string NtPath;
if (!GetObjectName(hFile, NtPath))
return false;
const auto& ReplaceRoot = [&](const auto& OldRoot, const auto& NewRoot)
{
if (!starts_with(NtPath, OldRoot))
return false;
FinalFilePath = NtPath.replace(0, OldRoot.size(), NewRoot.raw_data(), NewRoot.size());
return true;
};
// simple way to handle network paths
if (ReplaceRoot(L"\\Device\\LanmanRedirector"_sv, L"\\"_sv) || ReplaceRoot(L"\\Device\\Mup"_sv, L"\\"_sv))
return true;
// try to convert NT path (\Device\HarddiskVolume1) to drive letter
for (const auto& i : enum_drives(get_logical_drives()))
{
const auto Device = fs::get_drive(i);
if (const auto Len = MatchNtPathRoot(NtPath, Device))
{
FinalFilePath = starts_with(NtPath, L"\\Device\\WinDfs"_sv)? NtPath.replace(0, Len, 1, L'\\') : NtPath.replace(0, Len, Device);
return true;
}
}
// try to convert NT path (\Device\HarddiskVolume1) to \\?\Volume{...} path
for (auto& VolumeName : enum_volumes())
{
if (const auto Len = MatchNtPathRoot(NtPath, VolumeName.substr(4, VolumeName.size() - 5))) // w/o prefix and trailing slash
{
FinalFilePath = NtPath.replace(0, Len, VolumeName);
return true;
}
}
return false;
}
bool file::GetFinalPathName(string& FinalFilePath) const
{
const auto& GetFinalPathNameByHandleGuarded = [](HANDLE File, wchar_t* Buffer, DWORD Size, DWORD Flags)
{
// It seems that Microsoft has forgotten to put an exception handler around this function.
// It causes EXCEPTION_ACCESS_VIOLATION (read from 0) in kernel32 under certain conditions,
// e.g. badly written file system drivers or weirdly formatted volumes.
return seh_invoke_no_ui(
[&]
{
return Imports().GetFinalPathNameByHandle(File, Buffer, Size, Flags);
},
[]
{
SetLastError(ERROR_UNHANDLED_EXCEPTION);
return 0ul;
});
};
const auto& GetFinalPathNameByHandleImpl = [&]
{
return os::detail::ApiDynamicStringReceiver(FinalFilePath, [&](wchar_t* Buffer, size_t Size)
{
return GetFinalPathNameByHandleGuarded(m_Handle.native_handle(), Buffer, static_cast<DWORD>(Size), VOLUME_NAME_GUID);
});
};
return (Imports().GetFinalPathNameByHandleW && GetFinalPathNameByHandleImpl()) || internalNtQueryGetFinalPathNameByHandle(m_Handle.native_handle(), FinalFilePath);
}
void file::Close()
{
m_Handle.close();
}
bool file::Eof() const
{
const auto Ptr = GetPointer();
unsigned long long Size = 0;
GetSize(Size);
return Ptr >= Size;
}
const string& file::GetName() const
{
return m_Name;
}
const handle& file::get() const
{
return m_Handle;
}
void file::SyncPointer() const
{
if (!m_NeedSyncPointer)
return;
LARGE_INTEGER Distance, NewPointer;
Distance.QuadPart = m_Pointer;
if (!SetFilePointerEx(m_Handle.native_handle(), Distance, &NewPointer, FILE_BEGIN))
return;
m_Pointer = NewPointer.QuadPart;
m_NeedSyncPointer = false;
}
//-------------------------------------------------------------------------
struct file_walker::Chunk
{
unsigned long long Offset;
DWORD Size;
Chunk(unsigned long long Offset, DWORD Size):
Offset(Offset),
Size(Size)
{
}
};
file_walker::file_walker() = default;
file_walker::~file_walker() = default;
bool file_walker::InitWalk(size_t BlockSize)
{
if (!GetSize(m_FileSize) || !m_FileSize)
return false;
m_ChunkSize = static_cast<DWORD>(BlockSize);
BY_HANDLE_FILE_INFORMATION bhfi;
m_IsSparse = GetInformation(bhfi) && bhfi.dwFileAttributes & FILE_ATTRIBUTE_SPARSE_FILE;
if (!m_IsSparse)
{
m_AllocSize = m_FileSize;
m_ChunkList.emplace_back(0, static_cast<DWORD>(std::min(static_cast<unsigned long long>(BlockSize), m_FileSize)));
m_CurrentChunk = m_ChunkList.begin();