-
-
Notifications
You must be signed in to change notification settings - Fork 121
/
Copy pathfile.c
1230 lines (1163 loc) · 35.6 KB
/
file.c
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
/* file.c - file abstraction layer */
/* use 64-bit off_t.
* these macros must be defined before any included file */
#undef _LARGEFILE64_SOURCE
#undef _FILE_OFFSET_BITS
#define _LARGEFILE64_SOURCE
#define _FILE_OFFSET_BITS 64
#include "file.h"
#include "common_func.h"
#include "parse_cmdline.h"
#include "platform.h"
#include "win_utils.h"
#include <assert.h>
#include <errno.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <fcntl.h> /* _O_RDONLY, _O_BINARY, posix_fadvise */
#if defined(_WIN32) || defined(__CYGWIN__)
# define WIN32_LEAN_AND_MEAN
# include <windows.h>
#if !defined(__CYGWIN__)
# include <share.h> /* for _SH_DENYWR */
#endif
# include <io.h>
#endif
#define IS_ANY_SLASH(c) ((c) == '/' || (c) == '\\')
#define IS_ANY_TSLASH(c) ((c) == RSH_T('/') || (c) == RSH_T('\\'))
#define IS_DOT_STR(s) ((s)[0] == '.' && (s)[1] == 0)
#define IS_DOT_TSTR(s) ((s)[0] == '.' && (s)[1] == 0)
#ifdef _WIN32
/* auxiliary function */
static int str_is_ascii(const char* str)
{
for (; *str; str++)
if ((unsigned char)*str >= 0x80)
return 0;
return 1;
}
#endif
/*=========================================================================
* Path functions
*=========================================================================*/
/**
* Return file name without path.
*
* @param path file path
* @return file name
*/
const char* get_basename(const char* path)
{
const char* p;
if (!path)
return NULL;
for (p = path + strlen(path); p > path && !IS_PATH_SEPARATOR(*(p - 1)); p--);
return p;
}
#ifdef _WIN32
# define CHECK_SLASH(ch, alt_sep) IS_ANY_SLASH(ch)
#else
# define CHECK_SLASH(ch, alt_sep) ((ch) == SYS_PATH_SEPARATOR || (ch) == (alt_sep))
#endif
/**
* Return filepath, obtained by concatinating a directory path and a sub-path.
*
* @param dir_path (nullable) directory path
* @param sub_path the filepath to append to the directory
* @param flags bitmask consisting of the following bits:
* FileInitUpdatePrintPathSlashes - contacenate using user-defined slash
* FileInitUseRealPathAsIs - do not replace alternative path separators
* 0 to use system path separator
* @return concatinated file path
*/
char* make_path(const char* dir_path, const char* sub_path, unsigned flags)
{
char* buf;
size_t dir_len;
#ifndef _WIN32
char alt_sep = (flags & FileInitUseRealPathAsIs ? SYS_PATH_SEPARATOR : ALIEN_PATH_SEPARATOR);
#endif
assert(sub_path);
if (sub_path[0] == '.' && CHECK_SLASH(sub_path[1], alt_sep))
sub_path += 2;
if (!dir_path)
return rsh_strdup(sub_path);
/* remove leading path delimiters from sub_path */
for (; CHECK_SLASH(*sub_path, alt_sep); sub_path++);
if (dir_path[0] == 0 || IS_DOT_STR(dir_path)) {
/* do not extend sub_path for dir_path="." */
return rsh_strdup(sub_path);
}
/* remove trailing path delimiters from the directory path */
for (dir_len = strlen(dir_path); dir_len > 0 && CHECK_SLASH(dir_path[dir_len - 1], alt_sep); dir_len--);
/* copy directory path */
buf = (char*)rsh_malloc(dir_len + strlen(sub_path) + 2);
memcpy(buf, dir_path, dir_len);
/* insert path separator */
buf[dir_len++] = ((flags & FileMaskUpdatePrintPath) && opt.path_separator ? opt.path_separator : SYS_PATH_SEPARATOR);
strcpy(buf + dir_len, sub_path); /* append sub_path */
return buf;
}
#ifdef _WIN32
/**
* Return wide-string filepath, obtained by concatinating a directory path and a sub-path.
*
* @param dir_path (nullable) directory path
* @param dir_len length of directory path in characters
* @param sub_path the filepath to append to the directory
* @return concatinated file path
*/
tpath_t make_wpath(ctpath_t dir_path, size_t dir_len, ctpath_t sub_path)
{
wchar_t* result;
size_t len;
if (dir_path == 0 || IS_DOT_TSTR(dir_path))
dir_len = 0;
else {
if (IS_UNC_PREFIX(sub_path))
sub_path += UNC_PREFIX_SIZE;
if (sub_path[0] == L'.' && IS_PATH_SEPARATOR_W(sub_path[1]))
sub_path += 2;
/* remove leading path separators from sub_path */
for (; IS_PATH_SEPARATOR_W(*sub_path); sub_path++);
if (dir_len == (size_t)-1)
dir_len = wcslen(dir_path);
}
len = wcslen(sub_path);
result = (wchar_t*)rsh_malloc((dir_len + len + 2) * sizeof(wchar_t));
if (dir_len > 0) {
memcpy(result, dir_path, dir_len * sizeof(wchar_t));
if (!IS_PATH_SEPARATOR_W(result[dir_len - 1]) && sub_path[0]) {
/* append path separator to the directory */
result[dir_len++] = L'\\';
}
}
/* append sub_path */
memcpy(result + dir_len, sub_path, (len + 1) * sizeof(wchar_t));
return result;
}
/**
* Return wide-string filepath, obtained by concatinating a directory path and a sub-path.
* Windows UNC path is returned if the resulting path is too long.
*
* @param dir_path (nullable) directory path
* @param sub_path the filepath to append to the directory
* @return concatinated file path
*/
static tpath_t make_wpath_unc(ctpath_t dir_path, wchar_t* sub_path)
{
wchar_t* path = make_wpath(dir_path, (size_t)-1, sub_path);
wchar_t* long_path = get_long_path_if_needed(path);
if (!long_path)
return path;
free(path);
return long_path;
}
#endif /* _WIN32 */
/**
* Compare paths.
*
* @param path the first path
* @param file the second path
* @return 1 if paths a equal, 0 otherwise
*/
int are_paths_equal(ctpath_t path, file_t* file)
{
ctpath_t fpath;
if (!path || !file || !file->real_path) return 0;
fpath = file->real_path;
if (path[0] == RSH_T('.') && IS_ANY_TSLASH(path[1])) path += 2;
if (fpath[0] == RSH_T('.') && IS_ANY_TSLASH(fpath[1])) fpath += 2;
for (; *path; ++path, ++fpath) {
if (*path != *fpath && (!IS_ANY_TSLASH(*path) || !IS_ANY_TSLASH(*fpath))) {
/* paths are different */
return 0;
}
}
/* check if both paths terminated */
return (*path == *fpath);
}
#ifndef _WIN32
/**
* Convert a windows file path to a UNIX one, replacing '\\' by '/'.
*
* @param path the path to convert
* @return converted path
*/
static void convert_backslashes_to_unix(char* path)
{
for (; *path; path++) {
if (*path == '\\')
*path = '/';
}
}
#endif /* _WIN32 */
/*=========================================================================
* file_t functions
*=========================================================================*/
enum FileMemoryModeBits {
FileDontFreeRealPath = 0x1000,
FileDontFreePrintPath = 0x2000,
FileDontFreeNativePath = 0x4000,
FileMemoryModeMask = (FileDontFreeRealPath | FileDontFreePrintPath | FileDontFreeNativePath),
FileIsAsciiPrintPath = 0x10000,
FileDontUsePrintPath = 0x20000,
FileDontUseNativePath = 0x40000,
FileConversionMask = (FileIsAsciiPrintPath | FileDontUsePrintPath | FileDontUseNativePath)
};
/**
* Initialize file_t structure, associating it with the given file path.
*
* @param file the file_t structure to initialize
* @param path the file path
* @param init_flags initialization flags
*/
int file_init(file_t* file, ctpath_t path, unsigned init_flags)
{
#ifdef _WIN32
tpath_t long_path = get_long_path_if_needed(path);
#endif
memset(file, 0, sizeof(*file));
/* strip ./ from the start of the path */
if (path[0] == RSH_T('.') && IS_ANY_TSLASH(path[1]))
{
for (path += 2; IS_ANY_TSLASH(path[0]); path++);
if (!path[0])
path = RSH_T(".");
}
file->real_path = (tpath_t)path;
file->mode = (init_flags & FileMaskModeBits) | FileDontFreeRealPath;
if (((init_flags & FileMaskUpdatePrintPath) && opt.path_separator) IF_WINDOWS( || long_path))
{
/* initialize print_path using the path argument */
if (!file_get_print_path(file, FPathUtf8 | (init_flags & FileMaskUpdatePrintPath)))
{
IF_WINDOWS(free(long_path));
return -1;
}
}
#ifdef _WIN32
if (long_path)
{
file->real_path = long_path;
file->mode = init_flags & FileMaskModeBits;
}
else
#endif
{
if ((init_flags & FileInitReusePath) == 0)
{
file->mode = init_flags & FileMaskModeBits;
file->real_path = rsh_tstrdup(path);
#ifndef _WIN32
if ((init_flags & FileInitUseRealPathAsIs) == 0)
convert_backslashes_to_unix(file->real_path);
#endif
}
}
if ((init_flags & (FileInitRunFstat | FileInitRunLstat)) &&
file_stat(file, (init_flags & FileInitRunLstat)) < 0)
return -1;
return 0;
}
#ifdef _WIN32
static int file_statw(file_t* file);
/**
* Detect path encoding, by trying file_statw() the file in available encodings.
* The order of encodings is detected by init_flags bit mask.
* On success detection file->real_path is allocated.
*
* @param file the file to store
* @param dir_path (nullable) directory path to prepend to printable path
* @param print_path printable path, which encoding shall be detected
* @param init_flags bit flags, helping to detect the encoding
* @return encoding on success, -1 on failure with error code stored in errno
*/
static int detect_path_encoding(file_t* file, wchar_t* dir_path, const char* print_path, unsigned init_flags)
{
static unsigned encoding_flags[4] = { ConvertUtf8ToWcs | ConvertExact, ConvertNativeToWcs | ConvertExact,
ConvertUtf8ToWcs, ConvertNativeToWcs };
wchar_t* last_path = NULL;
unsigned convert_path = (dir_path ? 0 : ConvertPath);
int ascii = str_is_ascii(print_path);
int primary_path_index = ((opt.flags & OPT_UTF8) || (init_flags & FileInitUtf8PrintPath) || ascii ? 0 : 1);
int step = ((init_flags & FileInitUtf8PrintPath) || ascii ? 2 : 1);
int i;
assert(file && !file->real_path);
file->mode &= ~FileMaskStatBits;
if (ascii)
file->mode |= FileIsAsciiPrintPath;
/* detect encoding in two or four steps */
for (i = 0; i < 4; i += step) {
int path_index = i ^ primary_path_index;
wchar_t* path = convert_str_to_wcs(print_path, encoding_flags[path_index] | convert_path);
if (!path) {
if (!last_path)
continue;
file->real_path = last_path;
return primary_path_index;
}
if (dir_path) {
file->real_path = make_wpath_unc(dir_path, path);
free(path);
} else
file->real_path = path;
if (i < 2) {
if (file_statw(file) == 0 || errno == EACCES) {
free(last_path);
return (path_index & 1);
}
if (i == 0) {
if (step == 2)
return primary_path_index;
last_path = file->real_path;
continue;
}
free(file->real_path);
file->real_path = last_path;
if (file->real_path)
return primary_path_index;
} else if (file->real_path) {
return (path_index & 1);
}
assert(last_path == NULL);
}
errno = EILSEQ;
return -1;
}
#endif
/**
* Initialize file_t structure from a printable file path.
*
* @param file the file_t structure to initialize
* @param prepend_dir the directory to prepend to the print_path, to construct the file path, can be NULL
* @param print_path the printable representation of the file path
* @param init_flags initialization flags
* @return 0 on success, -1 on failure with error code stored in errno
*/
int file_init_by_print_path(file_t* file, file_t* prepend_dir, const char* print_path, unsigned init_flags)
{
#ifndef _WIN32
char alt_sep = (init_flags & FileInitUseRealPathAsIs ? SYS_PATH_SEPARATOR : ALIEN_PATH_SEPARATOR);
#endif
assert(print_path);
assert(!prepend_dir || prepend_dir->real_path);
memset(file, 0, sizeof(file_t));
file->mode = (init_flags & FileMaskModeBits);
if (init_flags & (FileIsStdStream | FileIsData)) {
file->print_path = print_path;
file->mode |= FileDontFreePrintPath | FileIsAsciiPrintPath;
return 0;
}
if (print_path[0] == '.' && CHECK_SLASH(print_path[1], alt_sep))
print_path += 2;
#ifdef _WIN32
{
const char** primary_path;
wchar_t* dir_path = (prepend_dir && !IS_DOT_TSTR(prepend_dir->real_path) ? prepend_dir->real_path : NULL);
int encoding = detect_path_encoding(file, dir_path, print_path, init_flags);
if (encoding < 0)
return -1;
if (encoding == 0) {
primary_path = &file->print_path;
} else {
primary_path = &file->native_path;
}
if ((init_flags & (FileInitReusePath | FileMaskUpdatePrintPath)) == FileInitReusePath) {
*primary_path = print_path;
file->mode |= (encoding == 0 ? FileDontFreePrintPath : FileDontFreeNativePath);
} else {
*primary_path = rsh_strdup(print_path);
}
}
#else
if (!prepend_dir || IS_DOT_STR(prepend_dir->real_path)) {
file_init(file, print_path, init_flags & (FileInitReusePath | FileInitUseRealPathAsIs | FileMaskModeBits));
} else {
file->real_path = make_path(prepend_dir->real_path, print_path, init_flags & FileInitUseRealPathAsIs);
file->mode = init_flags & FileMaskModeBits;
}
assert(file->print_path == NULL);
if ((init_flags & (FileInitReusePath | FileMaskUpdatePrintPath)) == FileInitReusePath) {
file->print_path = print_path;
file->mode |= FileDontFreePrintPath;
} else {
file->print_path = rsh_strdup(print_path);
}
#endif
/* note: FileMaskUpdatePrintPath flags are used only with file_init() */
assert((init_flags & FileMaskUpdatePrintPath) == 0);
if ((init_flags & (FileInitRunFstat | FileInitRunLstat)) &&
file_stat(file, (init_flags & FileInitRunLstat)) < 0)
return -1;
return 0;
}
/**
* Restore a character of the file path, if it was saved earler.
*
* @param file the file
*/
static void restore_saved_char(file_t* file)
{
unsigned saved = file->mode & FileMaskSavedChar;
assert(((unsigned)(FileMaskSavedChar) >> 24) == 0xff);
if (saved) {
file->mode &= ~FileMaskSavedChar;
if (file->data) {
*(file->data) = (char)(unsigned char)(saved >> 24);
file->data = 0;
}
}
}
/**
* Transform the given file path, according to passed flags.
*
* @param file the file
* @param path the file path to transform
* @param flags bitmask containing FPathBaseName, FPathNotNull and FileMaskUpdatePrintPath bit flags
* @return transformed path
*/
static const char* handle_rest_of_path_flags(file_t* file, const char* path, unsigned flags)
{
if (path == NULL)
return ((flags & FPathNotNull) ? (errno == EINVAL ? "(null)" : "(encoding error)") : NULL);
if ((flags & FileMaskUpdatePrintPath) != 0 && opt.path_separator) {
char* p = (char*)path - 1 + strlen(path);
for (; p >= path; p--) {
if (IS_ANY_SLASH(*p)) {
*p = opt.path_separator;
if ((flags & FileInitUpdatePrintPathLastSlash) != 0)
break;
}
}
}
if ((flags & (FPathBaseName | FPathDirName)) != 0)
{
const char* name = get_basename(path);
if ((flags & FPathBaseName) != 0)
return name;
if (name <= path)
return ".";
name--; /* point to the end of the file dirname */
if (*name && file)
{
/* store the character that terminates dirname */
assert((unsigned)FileMaskSavedChar == (unsigned)(0xff << 24));
file->mode |= ((unsigned)*name) << 24;
file->data = (char*)name;
*(char*)name = 0;
}
}
return path;
}
/**
* Get the print path of the file in utf8 or in a native encoding.
* Transformations specified by flags are applied.
* Encoding conversion on Windows can be lossy.
*
* @param file the file to get the path
* @param flags bitmask containing FPathUtf8, FPathNative, FPathBaseName, FPathNotNull
* and FileMaskUpdatePrintPath bit flags
* @return transformed print path of the file. If FPathNotNull flag is not specified,
* then NULL is returned on function fail with error code stored in errno.
* If FPathNotNull flag is set, then error code is transformed to returned string.
*/
const char* file_get_print_path(file_t* file, unsigned flags)
{
#ifdef _WIN32
unsigned convert_to;
unsigned dont_use_bit;
int is_utf8 = (opt.flags & OPT_UTF8 ? !(flags & FPathNative) : flags & FPathUtf8);
const char* secondary_path;
const char** primary_path = (is_utf8 || (file->mode & FileIsAsciiPrintPath) ? &file->print_path : &file->native_path);
restore_saved_char(file);
if (*primary_path)
return handle_rest_of_path_flags(file, *primary_path, flags);
if (is_utf8) {
convert_to = ConvertToUtf8;
dont_use_bit = FileDontUsePrintPath;
secondary_path = file->native_path;
} else {
convert_to = ConvertToNative;
dont_use_bit = FileDontUseNativePath;
secondary_path = file->print_path;
}
if (secondary_path) {
if ((file->mode & dont_use_bit) == 0) {
*primary_path = convert_str_encoding(secondary_path, convert_to);
if (!*primary_path)
file->mode |= dont_use_bit;
} else
errno = EILSEQ;
return handle_rest_of_path_flags(file, *primary_path, flags);
}
if (!file->real_path) {
errno = EINVAL;
return handle_rest_of_path_flags(NULL, NULL, flags);
}
*primary_path = convert_wcs_to_str(file->real_path, convert_to | ConvertPath);
if (!*primary_path)
return handle_rest_of_path_flags(NULL, NULL, flags);
if (str_is_ascii(*primary_path)) {
file->mode |= FileIsAsciiPrintPath;
if (primary_path != &file->print_path) {
file->print_path = *primary_path;
file->native_path = NULL;
primary_path = &file->print_path;
}
}
return handle_rest_of_path_flags(file, *primary_path, flags);
#else
const char* path = NULL;
restore_saved_char(file);
if (!file->print_path && !file->real_path)
errno = EINVAL;
else if ((flags & FPathReal) != 0) {
path = (file->real_path ? file->real_path : file->print_path);
flags &= ~FileMaskUpdatePrintPath;
} else {
if (!file->print_path && (flags & FileMaskUpdatePrintPath))
file->print_path = rsh_strdup(file->real_path);
path = (file->print_path ? file->print_path : file->real_path);
}
return handle_rest_of_path_flags(file, path, flags);
#endif
}
/**
* Free the memory allocated by the fields of the file_t structure.
*
* @param file the file_t structure to clean
*/
void file_cleanup(file_t* file)
{
if (!(file->mode & FileDontFreeRealPath))
free(file->real_path);
file->real_path = NULL;
if (!(file->mode & FileDontFreePrintPath))
free((char*)file->print_path);
file->print_path = NULL;
#ifdef _WIN32
if ((file->mode & FileDontFreeNativePath) == 0)
free((char*)file->native_path);
file->native_path = NULL;
#endif /* _WIN32 */
if (file->mode & FileIsData)
free(file->data);
file->data = NULL;
file->mtime = 0;
file->size = 0;
file->mode = 0;
}
/**
* Clone existing file_t structure to another.
*
* @param file the file_t structure to clone to
* @param orig_file the file to clone
*/
void file_clone(file_t* file, const file_t* orig_file)
{
memset(file, 0, sizeof(*file));
file->mode = orig_file->mode & FileMaskModeBits;
if (orig_file->real_path)
file->real_path = rsh_tstrdup(orig_file->real_path);
if (orig_file->print_path)
file->print_path = rsh_strdup(orig_file->print_path);
#ifdef _WIN32
if (orig_file->native_path)
file->native_path = rsh_strdup(orig_file->native_path);
#endif
}
/**
* Swap members of two file_t structures.
*
* @param first the first file
* @param second the second file
*/
void file_swap(file_t* first, file_t* second)
{
file_t tmp;
memcpy(&tmp, first, sizeof(file_t));
memcpy(first, second, sizeof(file_t));
memcpy(second, &tmp, sizeof(file_t));
}
/**
* Get a modified file path.
*
* @param path the file path to modify
* @param str the string to insert into/append to the source file path
* @param operation the operation determinating how to modify the file path, can be one of the values
* FModifyAppendSuffix, FModifyInsertBeforeExtension, FModifyRemoveExtension, FModifyGetParentDir
* @return allocated and modified file path on success, NULL on failure
*/
static char* get_modified_path(const char* path, const char* str, int operation)
{
size_t start_pos = (size_t)-1;
size_t end_pos = (size_t)-1;
if (!path)
return NULL;
if (operation != FModifyAppendSuffix) {
if (operation == FModifyGetParentDir) {
end_pos = strlen(path);
start_pos = (end_pos > 0 ? end_pos - 1 : 0);
for (; start_pos > 0 && !IS_ANY_SLASH(path[start_pos]); start_pos--);
if (start_pos == 0 && !IS_ANY_SLASH(path[start_pos]))
return rsh_strdup(".");
for (; start_pos > 0 && IS_ANY_SLASH(path[start_pos]); start_pos--);
start_pos++;
} else {
char* point = strrchr(path, '.');
if (!point)
return NULL;
start_pos = point - path;
if (operation == FModifyInsertBeforeExtension)
end_pos = start_pos;
}
}
return str_replace_n(path, start_pos, end_pos, str);
}
#ifdef _WIN32
/**
* Get a modified file path.
*
* @param path the file path to modify
* @param str the string to insert into/append to the source file path
* @param operation the operation determinating how to modify the file path, can be one of the values
* FModifyAppendSuffix, FModifyInsertBeforeExtension, FModifyRemoveExtension, FModifyGetParentDir
* @return allocated and modified file path on success, NULL on failure
*/
static tpath_t get_modified_tpath(ctpath_t path, const char* str, int operation)
{
size_t start_pos = (size_t)-1;
size_t end_pos = (size_t)-1;
if (!path)
return NULL;
if (operation != FModifyAppendSuffix) {
if (operation == FModifyGetParentDir) {
end_pos = wcslen(path);
start_pos = (end_pos > 0 ? end_pos - 1 : 0);
for (; start_pos > 0 && !IS_ANY_TSLASH(path[start_pos]); start_pos--);
if (start_pos == 0 && !IS_ANY_TSLASH(path[start_pos]))
return rsh_wcsdup(L".");
for (; start_pos > 0 && IS_ANY_TSLASH(path[start_pos]); start_pos--);
start_pos++;
} else {
rsh_tchar* point = wcsrchr(path, L'.');
if (!point)
return NULL;
start_pos = point - path;
if (operation == FModifyInsertBeforeExtension)
end_pos = start_pos;
}
}
return wcs_replace_n(path, start_pos, end_pos, str);
}
#else
# define get_modified_tpath get_modified_path
#endif
/**
* Initialize a (destination) file by modifying the path of another (source) file.
*
* @param dst destination file
* @param src source file
* @param str the string to insert into/append to the source file path
* @param operation the operation to do on src file, can be one of the values
* FModifyAppendSuffix, FModifyInsertBeforeExtension, FModifyRemoveExtension, FModifyGetParentDir
* @return 0 on success, -1 on failure with error code stored in errno
*/
int file_modify_path(file_t* dst, file_t* src, const char* str, int operation)
{
assert(operation == FModifyRemoveExtension || operation == FModifyGetParentDir || str);
assert(operation == FModifyAppendSuffix || operation == FModifyInsertBeforeExtension || !str);
memcpy(dst, src, sizeof(file_t));
dst->mode = 0;
dst->print_path = NULL;
IF_WINDOWS(dst->native_path = NULL);
dst->print_path = get_modified_path(src->print_path, str, operation);
if (!src->real_path)
{
if (!FILE_ISSPECIAL(src) || !dst->print_path)
{
errno = EINVAL;
return -1;
}
#ifdef _WIN32
dst->real_path = convert_str_to_wcs(dst->print_path, ConvertUtf8ToWcs);
#else
dst->real_path = rsh_tstrdup(dst->print_path);
#endif /* _WIN32 */
}
else
dst->real_path = get_modified_tpath(src->real_path, str, operation);
IF_WINDOWS(dst->native_path = get_modified_path(src->native_path, str, operation));
return 0;
}
#ifdef _WIN32
/**
* Retrieve file information (type, size, mtime) into file_t fields.
*
* @param file the file information
* @return 0 on success, -1 on failure with error code stored in errno
*/
static int file_statw(file_t* file)
{
WIN32_FILE_ATTRIBUTE_DATA data;
/* read file attributes */
if (GetFileAttributesExW(file->real_path, GetFileExInfoStandard, &data)) {
file->mode |= (data.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY ? FileIsDir : FileIsReg);
do {
uint64_t u;
if ((data.dwFileAttributes & FILE_ATTRIBUTE_REPARSE_POINT) == 0) {
/* Process a regular file or directory */
file->size = (((uint64_t)data.nFileSizeHigh) << 32) + data.nFileSizeLow;
} else {
/* Process a symlink (aka Reparse point) */
LARGE_INTEGER link_size;
HANDLE handle = CreateFileW(file->real_path,
GENERIC_READ, FILE_SHARE_READ, NULL,
OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
if (handle == INVALID_HANDLE_VALUE)
break;
if (!GetFileSizeEx(handle, &link_size))
break;
if (!GetFileTime(handle, NULL, NULL, &data.ftLastWriteTime))
break;
file->size = (((uint64_t)link_size.HighPart) << 32) + link_size.LowPart;
file->mode |= FileIsLnk;
}
/* the number of 100-nanosecond intervals since January 1, 1601 */
u = (((uint64_t)data.ftLastWriteTime.dwHighDateTime) << 32) + data.ftLastWriteTime.dwLowDateTime;
/* convert to seconds and subtract the epoch difference */
file->mtime = u / 10000000 - 11644473600LL;
return 0;
} while (0);
}
file->mode |= FileIsInaccessible;
set_errno_from_last_file_error();
return -1;
}
#endif
/**
* Retrieve file information (type, size, mtime) into file_t fields.
*
* @param file the file information
* @param fstat_flags bitmask consisting of FileStatModes bits
* @return 0 on success, -1 on failure with error code stored in errno
*/
int file_stat(file_t* file, int fstat_flags)
{
#ifdef _WIN32
(void)fstat_flags; /* ignore on windows */
#else
struct stat st;
#endif
file->size = 0;
file->mtime = 0;
file->mode &= ~FileMaskStatBits;
if (FILE_ISDATA(file) || FILE_ISSTDSTREAM(file))
return 0;
else if (!file->real_path) {
file->mode |= FileIsInaccessible;
errno = EINVAL;
return -1;
}
#ifdef _WIN32
return file_statw(file);
#else
if (stat(file->real_path, &st)) {
file->mode |= FileIsInaccessible;
return -1;
}
file->size = st.st_size;
file->mtime = st.st_mtime;
if (S_ISDIR(st.st_mode)) {
file->mode |= FileIsDir;
} else if (S_ISREG(st.st_mode)) {
/* it's a regular file or a symlink pointing to a regular file */
file->mode |= FileIsReg;
}
if ((fstat_flags & FUseLstat) && lstat(file->real_path, &st) == 0) {
if (S_ISLNK(st.st_mode))
file->mode |= FileIsLnk; /* it's a symlink */
}
return 0;
#endif
}
/**
* Open the file and return POSIX file descriptor.
*
* On Windows, the file is always opened in binary mode (`_O_BINARY`)
* and with `_SH_DENYNO` (shared read/write access).
* In read-only mode (`FOpenRead`), the file is opened with a hint for sequential access:
* - Windows: Uses `_O_SEQUENTIAL`.
* - POSIX: Uses `posix_fadvise(POSIX_FADV_SEQUENTIAL)` if available.
*
* @param file file information, including the path (must not be NULL)
* @param open_flags bitmask of `FOpenRead`, `FOpenWrite`
* @return POSIX file descriptor on success, -1 on failure with error code stored in errno
*/
int file_open(file_t* file, int open_flags)
{
const int possible_oflags[4] = {
#if defined(_WIN32)
0, _O_RDONLY | _O_BINARY | _O_SEQUENTIAL,
_O_WRONLY | _O_BINARY, _O_RDWR | _O_BINARY
#else
# if !defined(O_BINARY)
# define O_BINARY 0
# endif
0, O_RDONLY | O_BINARY, O_WRONLY | O_BINARY, O_RDWR | O_BINARY
#endif
};
const int oflags = possible_oflags[open_flags & FOpenRW];
int fd;
assert((open_flags & FOpenRW) != 0);
if (!file->real_path) {
errno = EINVAL;
return -1;
}
#ifdef _WIN32
{
fd = _wsopen(file->real_path, oflags, _SH_DENYNO, 0);
if (fd < 0 && errno == EINVAL)
errno = ENOENT;
return fd;
}
#else
fd = open(file->real_path, oflags, 0);
# if _POSIX_C_SOURCE >= 200112L && defined(POSIX_FADV_SEQUENTIAL)
if (fd >= 0)
posix_fadvise(fd, 0, 0, POSIX_FADV_SEQUENTIAL);
# endif /* _POSIX_C_SOURCE >= 200112L && defined(POSIX_FADV_SEQUENTIAL) */
return fd;
#endif
}
/**
* Open the file and return a standard C file stream pointer.
*
* On Windows, the file is opened with shared access (`_SH_DENYNO`)
* In read-only mode (`FOpenRead`), a hint for sequential access is applied.
*
* @param file the file information, including the path (must not be NULL)
* @param fopen_flags bitmask of `FOpenRead`, `FOpenWrite`, and optionally `FOpenBin`.
* Must include at least one of `FOpenRead` or `FOpenWrite`.
* @return valid `FILE*` stream on success, NULL on failure with error code stored in errno
*/
FILE* file_fopen(file_t* file, int fopen_flags)
{
const file_tchar* possible_modes[8] = {
0, RSH_T("r"), RSH_T("w"), RSH_T("r+"), 0,
#ifdef _WIN32
RSH_T("rbS"), /* open with _O_SEQUENTIAL */
#else
"rb",
#endif
RSH_T("wb"), RSH_T("r+b")
};
const file_tchar* mode = possible_modes[fopen_flags & FOpenMask];
FILE* fd;
assert((fopen_flags & FOpenRW) != 0);
if (!file->real_path) {
errno = EINVAL;
return NULL;
}
#ifdef _WIN32
{
fd = _wfsopen(file->real_path, mode, _SH_DENYNO);
if (!fd && errno == EINVAL)
errno = ENOENT;
return fd;
}
#else
fd = fopen(file->real_path, mode);
# if _POSIX_C_SOURCE >= 200112L && !defined(__STRICT_ANSI__)
if (fd)
posix_fadvise(fileno(fd), 0, 0, POSIX_FADV_SEQUENTIAL);
# endif /* _POSIX_C_SOURCE >= 200112L && !defined(__STRICT_ANSI__) */
return fd;
#endif
}
/**
* Rename or move the file. The source and destination paths should be on the same device.
*
* @param from the source file
* @param to the destination path
* @return 0 on success, -1 on failure with error code stored in errno
*/
int file_rename(const file_t* from, const file_t* to)
{
#ifdef _WIN32
if (!from->real_path || !to->real_path) {
errno = EINVAL;
return -1;
}
/* Windows: file must be removed before overwriting it */
_wunlink(to->real_path);
return _wrename(from->real_path, to->real_path);
#else
return rename(from->real_path, to->real_path);
#endif
}
/**
* Rename a given file to *.bak, if it exists.
*
* @param file the file to move
* @return 0 on success, -1 on failure with error code stored in errno
*/
int file_move_to_bak(file_t* file)
{
if (FILE_ISSPECIAL(file))
return 0;
else if (file_stat(file, 0) >= 0) {
int res;
int save_errno;
file_t bak_file;
file_modify_path(&bak_file, file, ".bak", FModifyAppendSuffix);
res = file_rename(file, &bak_file);
save_errno = errno;
file_cleanup(&bak_file);
if (res < 0)
errno = save_errno;
return res;
}
return -1;
}
#ifdef _WIN32
/**
* Check if the specified path points to a readable file.
*
* @param real_path file path
* @param is_readable pointer to the result, it is set to 1, if the file is readable, to 0 otherwise
* @return 1 if the file with such path exists, 0 otherwise
*/
static int real_path_is_readable(wchar_t* real_path, int* is_readable)
{
/* note: using _wsopen, since _waccess doesn't check permissions */
int fd = _wsopen(real_path, _O_RDONLY | _O_BINARY, _SH_DENYNO);
*is_readable = (fd >= 0);
if (fd >= 0) {
_close(fd);
return 1;
}
return (errno == EACCES);
}
#endif
/**
* Check if the given file can't be opened for reading.
*
* @param file the file
* @return 1 if the file can be opened for reading, 0 otherwise
*/
int file_is_readable(file_t* file)
{
#ifdef _WIN32
if (file->real_path) {
int is_readable;
(void)real_path_is_readable(file->real_path, &is_readable);
return is_readable;