forked from chromium/chromium
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathfile_util_posix.cc
1317 lines (1139 loc) · 42.7 KB
/
file_util_posix.cc
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
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "base/files/file_util.h"
#include <dirent.h>
#include <errno.h>
#include <fcntl.h>
#include <libgen.h>
#include <limits.h>
#include <stddef.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/mman.h>
#include <sys/param.h>
#include <sys/time.h>
#include <sys/types.h>
#include <time.h>
#include <unistd.h>
#include "base/base_switches.h"
#include "base/bits.h"
#include "base/command_line.h"
#include "base/containers/contains.h"
#include "base/containers/stack.h"
#include "base/cxx17_backports.h"
#include "base/environment.h"
#include "base/files/file_enumerator.h"
#include "base/files/file_path.h"
#include "base/files/scoped_file.h"
#include "base/logging.h"
#include "base/memory/singleton.h"
#include "base/numerics/safe_conversions.h"
#include "base/path_service.h"
#include "base/posix/eintr_wrapper.h"
#include "base/strings/strcat.h"
#include "base/strings/string_piece.h"
#include "base/strings/string_split.h"
#include "base/strings/string_util.h"
#include "base/strings/sys_string_conversions.h"
#include "base/strings/utf_string_conversions.h"
#include "base/system/sys_info.h"
#include "base/threading/scoped_blocking_call.h"
#include "base/time/time.h"
#include "build/branding_buildflags.h"
#include "build/build_config.h"
#include "build/chromeos_buildflags.h"
#if defined(OS_APPLE)
#include <AvailabilityMacros.h>
#include "base/mac/foundation_util.h"
#endif
#if defined(OS_LINUX) || defined(OS_CHROMEOS) || defined(OS_ANDROID)
#include <sys/sendfile.h>
#endif
#if defined(OS_ANDROID)
#include "base/android/content_uri_utils.h"
#include "base/os_compat_android.h"
#endif
#if !defined(OS_IOS)
#include <grp.h>
#endif
// We need to do this on AIX due to some inconsistencies in how AIX
// handles XOPEN_SOURCE and ALL_SOURCE.
#if defined(OS_AIX)
extern "C" char* mkdtemp(char* path);
#endif
namespace base {
namespace {
#if !defined(OS_NACL_NONSFI)
// Helper for VerifyPathControlledByUser.
bool VerifySpecificPathControlledByUser(const FilePath& path,
uid_t owner_uid,
const std::set<gid_t>& group_gids) {
stat_wrapper_t stat_info;
if (File::Lstat(path.value().c_str(), &stat_info) != 0) {
DPLOG(ERROR) << "Failed to get information on path "
<< path.value();
return false;
}
if (S_ISLNK(stat_info.st_mode)) {
DLOG(ERROR) << "Path " << path.value() << " is a symbolic link.";
return false;
}
if (stat_info.st_uid != owner_uid) {
DLOG(ERROR) << "Path " << path.value() << " is owned by the wrong user.";
return false;
}
if ((stat_info.st_mode & S_IWGRP) &&
!Contains(group_gids, stat_info.st_gid)) {
DLOG(ERROR) << "Path " << path.value()
<< " is writable by an unprivileged group.";
return false;
}
if (stat_info.st_mode & S_IWOTH) {
DLOG(ERROR) << "Path " << path.value() << " is writable by any user.";
return false;
}
return true;
}
base::FilePath GetTempTemplate() {
return FormatTemporaryFileName("XXXXXX");
}
bool AdvanceEnumeratorWithStat(FileEnumerator* traversal,
FilePath* out_next_path,
stat_wrapper_t* out_next_stat) {
DCHECK(out_next_path);
DCHECK(out_next_stat);
*out_next_path = traversal->Next();
if (out_next_path->empty())
return false;
*out_next_stat = traversal->GetInfo().stat();
return true;
}
bool DoCopyDirectory(const FilePath& from_path,
const FilePath& to_path,
bool recursive,
bool open_exclusive) {
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
// Some old callers of CopyDirectory want it to support wildcards.
// After some discussion, we decided to fix those callers.
// Break loudly here if anyone tries to do this.
DCHECK(to_path.value().find('*') == std::string::npos);
DCHECK(from_path.value().find('*') == std::string::npos);
if (from_path.value().size() >= PATH_MAX) {
return false;
}
// This function does not properly handle destinations within the source
FilePath real_to_path = to_path;
if (PathExists(real_to_path))
real_to_path = MakeAbsoluteFilePath(real_to_path);
else
real_to_path = MakeAbsoluteFilePath(real_to_path.DirName());
if (real_to_path.empty())
return false;
FilePath real_from_path = MakeAbsoluteFilePath(from_path);
if (real_from_path.empty())
return false;
if (real_to_path == real_from_path || real_from_path.IsParent(real_to_path))
return false;
int traverse_type = FileEnumerator::FILES | FileEnumerator::SHOW_SYM_LINKS;
if (recursive)
traverse_type |= FileEnumerator::DIRECTORIES;
FileEnumerator traversal(from_path, recursive, traverse_type);
// We have to mimic windows behavior here. |to_path| may not exist yet,
// start the loop with |to_path|.
stat_wrapper_t from_stat;
FilePath current = from_path;
if (File::Stat(from_path.value().c_str(), &from_stat) < 0) {
DPLOG(ERROR) << "CopyDirectory() couldn't stat source directory: "
<< from_path.value();
return false;
}
FilePath from_path_base = from_path;
if (recursive && DirectoryExists(to_path)) {
// If the destination already exists and is a directory, then the
// top level of source needs to be copied.
from_path_base = from_path.DirName();
}
// The Windows version of this function assumes that non-recursive calls
// will always have a directory for from_path.
// TODO(maruel): This is not necessary anymore.
DCHECK(recursive || S_ISDIR(from_stat.st_mode));
do {
// current is the source path, including from_path, so append
// the suffix after from_path to to_path to create the target_path.
FilePath target_path(to_path);
if (from_path_base != current &&
!from_path_base.AppendRelativePath(current, &target_path)) {
return false;
}
if (S_ISDIR(from_stat.st_mode)) {
mode_t mode = (from_stat.st_mode & 01777) | S_IRUSR | S_IXUSR | S_IWUSR;
if (mkdir(target_path.value().c_str(), mode) == 0)
continue;
if (errno == EEXIST && !open_exclusive)
continue;
DPLOG(ERROR) << "CopyDirectory() couldn't create directory: "
<< target_path.value();
return false;
}
if (!S_ISREG(from_stat.st_mode)) {
DLOG(WARNING) << "CopyDirectory() skipping non-regular file: "
<< current.value();
continue;
}
// Add O_NONBLOCK so we can't block opening a pipe.
File infile(open(current.value().c_str(), O_RDONLY | O_NONBLOCK));
if (!infile.IsValid()) {
DPLOG(ERROR) << "CopyDirectory() couldn't open file: " << current.value();
return false;
}
stat_wrapper_t stat_at_use;
if (File::Fstat(infile.GetPlatformFile(), &stat_at_use) < 0) {
DPLOG(ERROR) << "CopyDirectory() couldn't stat file: " << current.value();
return false;
}
if (!S_ISREG(stat_at_use.st_mode)) {
DLOG(WARNING) << "CopyDirectory() skipping non-regular file: "
<< current.value();
continue;
}
int open_flags = O_WRONLY | O_CREAT;
// If |open_exclusive| is set then we should always create the destination
// file, so O_NONBLOCK is not necessary to ensure we don't block on the
// open call for the target file below, and since the destination will
// always be a regular file it wouldn't affect the behavior of the
// subsequent write calls anyway.
if (open_exclusive)
open_flags |= O_EXCL;
else
open_flags |= O_TRUNC | O_NONBLOCK;
// Each platform has different default file opening modes for CopyFile which
// we want to replicate here. On OS X, we use copyfile(3) which takes the
// source file's permissions into account. On the other platforms, we just
// use the base::File constructor. On Chrome OS, base::File uses a different
// set of permissions than it does on other POSIX platforms.
#if defined(OS_APPLE)
int mode = 0600 | (stat_at_use.st_mode & 0177);
#elif BUILDFLAG(IS_CHROMEOS_ASH) || BUILDFLAG(IS_CHROMEOS_LACROS)
int mode = 0644;
#else
int mode = 0600;
#endif
File outfile(open(target_path.value().c_str(), open_flags, mode));
if (!outfile.IsValid()) {
DPLOG(ERROR) << "CopyDirectory() couldn't create file: "
<< target_path.value();
return false;
}
if (!CopyFileContents(infile, outfile)) {
DLOG(ERROR) << "CopyDirectory() couldn't copy file: " << current.value();
return false;
}
} while (AdvanceEnumeratorWithStat(&traversal, ¤t, &from_stat));
return true;
}
// TODO(erikkay): The Windows version of this accepts paths like "foo/bar/*"
// which works both with and without the recursive flag. I'm not sure we need
// that functionality. If not, remove from file_util_win.cc, otherwise add it
// here.
bool DoDeleteFile(const FilePath& path, bool recursive) {
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
#if defined(OS_ANDROID)
if (path.IsContentUri())
return DeleteContentUri(path);
#endif // defined(OS_ANDROID)
const char* path_str = path.value().c_str();
stat_wrapper_t file_info;
if (File::Lstat(path_str, &file_info) != 0) {
// The Windows version defines this condition as success.
return (errno == ENOENT);
}
if (!S_ISDIR(file_info.st_mode))
return (unlink(path_str) == 0) || (errno == ENOENT);
if (!recursive)
return (rmdir(path_str) == 0) || (errno == ENOENT);
bool success = true;
stack<std::string> directories;
directories.push(path.value());
FileEnumerator traversal(path, true,
FileEnumerator::FILES | FileEnumerator::DIRECTORIES |
FileEnumerator::SHOW_SYM_LINKS);
for (FilePath current = traversal.Next(); !current.empty();
current = traversal.Next()) {
if (traversal.GetInfo().IsDirectory())
directories.push(current.value());
else
success &= (unlink(current.value().c_str()) == 0) || (errno == ENOENT);
}
while (!directories.empty()) {
FilePath dir = FilePath(directories.top());
directories.pop();
success &= (rmdir(dir.value().c_str()) == 0) || (errno == ENOENT);
}
return success;
}
#endif // !defined(OS_NACL_NONSFI)
#if !defined(OS_APPLE)
// Appends |mode_char| to |mode| before the optional character set encoding; see
// https://www.gnu.org/software/libc/manual/html_node/Opening-Streams.html for
// details.
std::string AppendModeCharacter(StringPiece mode, char mode_char) {
std::string result(mode);
size_t comma_pos = result.find(',');
result.insert(comma_pos == std::string::npos ? result.length() : comma_pos, 1,
mode_char);
return result;
}
#endif
} // namespace
#if !defined(OS_NACL_NONSFI)
FilePath MakeAbsoluteFilePath(const FilePath& input) {
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
char full_path[PATH_MAX];
if (realpath(input.value().c_str(), full_path) == nullptr)
return FilePath();
return FilePath(full_path);
}
bool DeleteFile(const FilePath& path) {
return DoDeleteFile(path, /*recursive=*/false);
}
bool DeletePathRecursively(const FilePath& path) {
return DoDeleteFile(path, /*recursive=*/true);
}
bool ReplaceFile(const FilePath& from_path,
const FilePath& to_path,
File::Error* error) {
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
if (rename(from_path.value().c_str(), to_path.value().c_str()) == 0)
return true;
if (error)
*error = File::GetLastFileError();
return false;
}
bool CopyDirectory(const FilePath& from_path,
const FilePath& to_path,
bool recursive) {
return DoCopyDirectory(from_path, to_path, recursive, false);
}
bool CopyDirectoryExcl(const FilePath& from_path,
const FilePath& to_path,
bool recursive) {
return DoCopyDirectory(from_path, to_path, recursive, true);
}
#endif // !defined(OS_NACL_NONSFI)
bool CreatePipe(ScopedFD* read_fd, ScopedFD* write_fd, bool non_blocking) {
int fds[2];
bool created =
non_blocking ? CreateLocalNonBlockingPipe(fds) : (0 == pipe(fds));
if (!created)
return false;
read_fd->reset(fds[0]);
write_fd->reset(fds[1]);
return true;
}
bool CreateLocalNonBlockingPipe(int fds[2]) {
#if defined(OS_LINUX) || defined(OS_CHROMEOS)
return pipe2(fds, O_CLOEXEC | O_NONBLOCK) == 0;
#else
int raw_fds[2];
if (pipe(raw_fds) != 0)
return false;
ScopedFD fd_out(raw_fds[0]);
ScopedFD fd_in(raw_fds[1]);
if (!SetCloseOnExec(fd_out.get()))
return false;
if (!SetCloseOnExec(fd_in.get()))
return false;
if (!SetNonBlocking(fd_out.get()))
return false;
if (!SetNonBlocking(fd_in.get()))
return false;
fds[0] = fd_out.release();
fds[1] = fd_in.release();
return true;
#endif
}
bool SetNonBlocking(int fd) {
const int flags = fcntl(fd, F_GETFL);
if (flags == -1)
return false;
if (flags & O_NONBLOCK)
return true;
if (HANDLE_EINTR(fcntl(fd, F_SETFL, flags | O_NONBLOCK)) == -1)
return false;
return true;
}
bool SetCloseOnExec(int fd) {
#if defined(OS_NACL_NONSFI)
const int flags = 0;
#else
const int flags = fcntl(fd, F_GETFD);
if (flags == -1)
return false;
if (flags & FD_CLOEXEC)
return true;
#endif // defined(OS_NACL_NONSFI)
if (HANDLE_EINTR(fcntl(fd, F_SETFD, flags | FD_CLOEXEC)) == -1)
return false;
return true;
}
bool PathExists(const FilePath& path) {
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
#if defined(OS_ANDROID)
if (path.IsContentUri()) {
return ContentUriExists(path);
}
#endif
return access(path.value().c_str(), F_OK) == 0;
}
#if !defined(OS_NACL_NONSFI)
bool PathIsReadable(const FilePath& path) {
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
return access(path.value().c_str(), R_OK) == 0;
}
#endif // !defined(OS_NACL_NONSFI)
#if !defined(OS_NACL_NONSFI)
bool PathIsWritable(const FilePath& path) {
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
return access(path.value().c_str(), W_OK) == 0;
}
#endif // !defined(OS_NACL_NONSFI)
bool DirectoryExists(const FilePath& path) {
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
stat_wrapper_t file_info;
if (File::Stat(path.value().c_str(), &file_info) != 0)
return false;
return S_ISDIR(file_info.st_mode);
}
bool ReadFromFD(int fd, char* buffer, size_t bytes) {
size_t total_read = 0;
while (total_read < bytes) {
ssize_t bytes_read =
HANDLE_EINTR(read(fd, buffer + total_read, bytes - total_read));
if (bytes_read <= 0)
break;
total_read += bytes_read;
}
return total_read == bytes;
}
#if !defined(OS_NACL_NONSFI)
ScopedFD CreateAndOpenFdForTemporaryFileInDir(const FilePath& directory,
FilePath* path) {
ScopedBlockingCall scoped_blocking_call(
FROM_HERE,
BlockingType::MAY_BLOCK); // For call to mkstemp().
*path = directory.Append(GetTempTemplate());
const std::string& tmpdir_string = path->value();
// this should be OK since mkstemp just replaces characters in place
char* buffer = const_cast<char*>(tmpdir_string.c_str());
return ScopedFD(HANDLE_EINTR(mkstemp(buffer)));
}
#if !defined(OS_FUCHSIA)
bool CreateSymbolicLink(const FilePath& target_path,
const FilePath& symlink_path) {
DCHECK(!symlink_path.empty());
DCHECK(!target_path.empty());
return ::symlink(target_path.value().c_str(),
symlink_path.value().c_str()) != -1;
}
bool ReadSymbolicLink(const FilePath& symlink_path, FilePath* target_path) {
DCHECK(!symlink_path.empty());
DCHECK(target_path);
char buf[PATH_MAX];
ssize_t count =
::readlink(symlink_path.value().c_str(), buf, base::size(buf));
#if defined(OS_ANDROID) && defined(__LP64__)
// A few 64-bit Android L/M devices return INT_MAX instead of -1 here for
// errors; this is related to bionic's (incorrect) definition of ssize_t as
// being long int instead of int. Cast it so the compiler generates the
// comparison we want here. https://crbug.com/1101940
bool error = static_cast<int32_t>(count) <= 0;
#else
bool error = count <= 0;
#endif
if (error) {
target_path->clear();
return false;
}
*target_path = FilePath(FilePath::StringType(buf, count));
return true;
}
bool GetPosixFilePermissions(const FilePath& path, int* mode) {
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
DCHECK(mode);
stat_wrapper_t file_info;
// Uses stat(), because on symbolic link, lstat() does not return valid
// permission bits in st_mode
if (File::Stat(path.value().c_str(), &file_info) != 0)
return false;
*mode = file_info.st_mode & FILE_PERMISSION_MASK;
return true;
}
bool SetPosixFilePermissions(const FilePath& path,
int mode) {
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
DCHECK_EQ(mode & ~FILE_PERMISSION_MASK, 0);
// Calls stat() so that we can preserve the higher bits like S_ISGID.
stat_wrapper_t stat_buf;
if (File::Stat(path.value().c_str(), &stat_buf) != 0)
return false;
// Clears the existing permission bits, and adds the new ones.
mode_t updated_mode_bits = stat_buf.st_mode & ~FILE_PERMISSION_MASK;
updated_mode_bits |= mode & FILE_PERMISSION_MASK;
if (HANDLE_EINTR(chmod(path.value().c_str(), updated_mode_bits)) != 0)
return false;
return true;
}
bool ExecutableExistsInPath(Environment* env,
const FilePath::StringType& executable) {
std::string path;
if (!env->GetVar("PATH", &path)) {
LOG(ERROR) << "No $PATH variable. Assuming no " << executable << ".";
return false;
}
for (const StringPiece& cur_path :
SplitStringPiece(path, ":", KEEP_WHITESPACE, SPLIT_WANT_NONEMPTY)) {
FilePath file(cur_path);
int permissions;
if (GetPosixFilePermissions(file.Append(executable), &permissions) &&
(permissions & FILE_PERMISSION_EXECUTE_BY_USER))
return true;
}
return false;
}
#endif // !OS_FUCHSIA
#if !defined(OS_APPLE)
// This is implemented in file_util_mac.mm for Mac.
bool GetTempDir(FilePath* path) {
const char* tmp = getenv("TMPDIR");
if (tmp) {
*path = FilePath(tmp);
return true;
}
#if defined(OS_ANDROID)
return PathService::Get(DIR_CACHE, path);
#else
*path = FilePath("/tmp");
return true;
#endif
}
#endif // !defined(OS_APPLE)
#if !defined(OS_APPLE) // Mac implementation is in file_util_mac.mm.
FilePath GetHomeDir() {
#if BUILDFLAG(IS_CHROMEOS_ASH) || BUILDFLAG(IS_CHROMEOS_LACROS)
if (SysInfo::IsRunningOnChromeOS()) {
// On Chrome OS chrome::DIR_USER_DATA is overridden with a primary user
// homedir once it becomes available. Return / as the safe option.
return FilePath("/");
}
#endif
const char* home_dir = getenv("HOME");
if (home_dir && home_dir[0])
return FilePath(home_dir);
#if defined(OS_ANDROID)
DLOG(WARNING) << "OS_ANDROID: Home directory lookup not yet implemented.";
#endif
FilePath rv;
if (GetTempDir(&rv))
return rv;
// Last resort.
return FilePath("/tmp");
}
#endif // !defined(OS_APPLE)
File CreateAndOpenTemporaryFileInDir(const FilePath& dir, FilePath* temp_file) {
// For call to close() inside ScopedFD.
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
ScopedFD fd = CreateAndOpenFdForTemporaryFileInDir(dir, temp_file);
return fd.is_valid() ? File(std::move(fd)) : File(File::GetLastFileError());
}
bool CreateTemporaryFileInDir(const FilePath& dir, FilePath* temp_file) {
// For call to close() inside ScopedFD.
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
ScopedFD fd = CreateAndOpenFdForTemporaryFileInDir(dir, temp_file);
return fd.is_valid();
}
FilePath FormatTemporaryFileName(FilePath::StringPieceType identifier) {
#if defined(OS_APPLE)
StringPiece prefix = base::mac::BaseBundleID();
#elif BUILDFLAG(GOOGLE_CHROME_BRANDING)
StringPiece prefix = "com.google.Chrome";
#else
StringPiece prefix = "org.chromium.Chromium";
#endif
return FilePath(StrCat({".", prefix, ".", identifier}));
}
ScopedFILE CreateAndOpenTemporaryStreamInDir(const FilePath& dir,
FilePath* path) {
ScopedFD scoped_fd = CreateAndOpenFdForTemporaryFileInDir(dir, path);
if (!scoped_fd.is_valid())
return nullptr;
int fd = scoped_fd.release();
FILE* file = fdopen(fd, "a+");
if (!file)
close(fd);
return ScopedFILE(file);
}
static bool CreateTemporaryDirInDirImpl(const FilePath& base_dir,
const FilePath& name_tmpl,
FilePath* new_dir) {
ScopedBlockingCall scoped_blocking_call(
FROM_HERE, BlockingType::MAY_BLOCK); // For call to mkdtemp().
DCHECK(EndsWith(name_tmpl.value(), "XXXXXX"))
<< "Directory name template must end with \"XXXXXX\".";
FilePath sub_dir = base_dir.Append(name_tmpl);
std::string sub_dir_string = sub_dir.value();
// this should be OK since mkdtemp just replaces characters in place
char* buffer = const_cast<char*>(sub_dir_string.c_str());
char* dtemp = mkdtemp(buffer);
if (!dtemp) {
DPLOG(ERROR) << "mkdtemp";
return false;
}
*new_dir = FilePath(dtemp);
return true;
}
bool CreateTemporaryDirInDir(const FilePath& base_dir,
const FilePath::StringType& prefix,
FilePath* new_dir) {
FilePath::StringType mkdtemp_template = prefix;
mkdtemp_template.append("XXXXXX");
return CreateTemporaryDirInDirImpl(base_dir, FilePath(mkdtemp_template),
new_dir);
}
bool CreateNewTempDirectory(const FilePath::StringType& prefix,
FilePath* new_temp_path) {
FilePath tmpdir;
if (!GetTempDir(&tmpdir))
return false;
return CreateTemporaryDirInDirImpl(tmpdir, GetTempTemplate(), new_temp_path);
}
bool CreateDirectoryAndGetError(const FilePath& full_path,
File::Error* error) {
ScopedBlockingCall scoped_blocking_call(
FROM_HERE, BlockingType::MAY_BLOCK); // For call to mkdir().
std::vector<FilePath> subpaths;
// Collect a list of all parent directories.
FilePath last_path = full_path;
subpaths.push_back(full_path);
for (FilePath path = full_path.DirName();
path.value() != last_path.value(); path = path.DirName()) {
subpaths.push_back(path);
last_path = path;
}
// Iterate through the parents and create the missing ones.
for (auto i = subpaths.rbegin(); i != subpaths.rend(); ++i) {
if (DirectoryExists(*i))
continue;
if (mkdir(i->value().c_str(), 0700) == 0)
continue;
// Mkdir failed, but it might have failed with EEXIST, or some other error
// due to the directory appearing out of thin air. This can occur if
// two processes are trying to create the same file system tree at the same
// time. Check to see if it exists and make sure it is a directory.
int saved_errno = errno;
if (!DirectoryExists(*i)) {
if (error)
*error = File::OSErrorToFileError(saved_errno);
return false;
}
}
return true;
}
// ReadFileToStringNonBlockingNonBlocking will read a file to a string. This
// method should only be used on files which are known to be non-blocking such
// as procfs or sysfs nodes. Additionally, the file is opened as O_NONBLOCK so
// it WILL NOT block even if opened on a blocking file. It will return true if
// the file read until EOF and it will return false otherwise, errno will remain
// set on error conditions. |ret| will be populated with the contents of the
// file.
bool ReadFileToStringNonBlocking(const base::FilePath& file, std::string* ret) {
DCHECK(ret);
ret->clear();
base::ScopedFD fd(HANDLE_EINTR(
open(file.MaybeAsASCII().c_str(), O_CLOEXEC | O_NONBLOCK | O_RDONLY)));
if (!fd.is_valid()) {
return false;
}
ssize_t bytes_read = 0;
do {
char buf[4096];
bytes_read = HANDLE_EINTR(read(fd.get(), buf, sizeof(buf)));
if (bytes_read < 0) {
return false;
} else if (bytes_read > 0) {
ret->append(buf, bytes_read);
}
} while (bytes_read > 0);
return true;
}
bool NormalizeFilePath(const FilePath& path, FilePath* normalized_path) {
FilePath real_path_result = MakeAbsoluteFilePath(path);
if (real_path_result.empty())
return false;
// To be consistant with windows, fail if |real_path_result| is a
// directory.
if (DirectoryExists(real_path_result))
return false;
*normalized_path = real_path_result;
return true;
}
// TODO(rkc): Refactor GetFileInfo and FileEnumerator to handle symlinks
// correctly. http://code.google.com/p/chromium-os/issues/detail?id=15948
bool IsLink(const FilePath& file_path) {
stat_wrapper_t st;
// If we can't lstat the file, it's safe to assume that the file won't at
// least be a 'followable' link.
if (File::Lstat(file_path.value().c_str(), &st) != 0)
return false;
return S_ISLNK(st.st_mode);
}
bool GetFileInfo(const FilePath& file_path, File::Info* results) {
stat_wrapper_t file_info;
#if defined(OS_ANDROID)
if (file_path.IsContentUri()) {
File file = OpenContentUriForRead(file_path);
if (!file.IsValid())
return false;
return file.GetInfo(results);
} else {
#endif // defined(OS_ANDROID)
if (File::Stat(file_path.value().c_str(), &file_info) != 0)
return false;
#if defined(OS_ANDROID)
}
#endif // defined(OS_ANDROID)
results->FromStat(file_info);
return true;
}
#endif // !defined(OS_NACL_NONSFI)
FILE* OpenFile(const FilePath& filename, const char* mode) {
// 'e' is unconditionally added below, so be sure there is not one already
// present before a comma in |mode|.
DCHECK(
strchr(mode, 'e') == nullptr ||
(strchr(mode, ',') != nullptr && strchr(mode, 'e') > strchr(mode, ',')));
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
FILE* result = nullptr;
#if defined(OS_APPLE)
// macOS does not provide a mode character to set O_CLOEXEC; see
// https://developer.apple.com/legacy/library/documentation/Darwin/Reference/ManPages/man3/fopen.3.html.
const char* the_mode = mode;
#else
std::string mode_with_e(AppendModeCharacter(mode, 'e'));
const char* the_mode = mode_with_e.c_str();
#endif
do {
result = fopen(filename.value().c_str(), the_mode);
} while (!result && errno == EINTR);
#if defined(OS_APPLE)
// Mark the descriptor as close-on-exec.
if (result)
SetCloseOnExec(fileno(result));
#endif
return result;
}
// NaCl doesn't implement system calls to open files directly.
#if !defined(OS_NACL)
FILE* FileToFILE(File file, const char* mode) {
FILE* stream = fdopen(file.GetPlatformFile(), mode);
if (stream)
file.TakePlatformFile();
return stream;
}
File FILEToFile(FILE* file_stream) {
if (!file_stream)
return File();
PlatformFile fd = fileno(file_stream);
DCHECK_NE(fd, -1);
ScopedPlatformFile other_fd(HANDLE_EINTR(dup(fd)));
if (!other_fd.is_valid())
return File(File::GetLastFileError());
return File(std::move(other_fd));
}
#endif // !defined(OS_NACL)
int ReadFile(const FilePath& filename, char* data, int max_size) {
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
int fd = HANDLE_EINTR(open(filename.value().c_str(), O_RDONLY));
if (fd < 0)
return -1;
ssize_t bytes_read = HANDLE_EINTR(read(fd, data, max_size));
if (IGNORE_EINTR(close(fd)) < 0)
return -1;
return bytes_read;
}
int WriteFile(const FilePath& filename, const char* data, int size) {
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
int fd = HANDLE_EINTR(creat(filename.value().c_str(), 0666));
if (fd < 0)
return -1;
int bytes_written =
WriteFileDescriptor(fd, StringPiece(data, size)) ? size : -1;
if (IGNORE_EINTR(close(fd)) < 0)
return -1;
return bytes_written;
}
bool WriteFileDescriptor(int fd, span<const uint8_t> data) {
// Allow for partial writes.
ssize_t bytes_written_total = 0;
ssize_t size = checked_cast<ssize_t>(data.size());
for (ssize_t bytes_written_partial = 0; bytes_written_total < size;
bytes_written_total += bytes_written_partial) {
bytes_written_partial = HANDLE_EINTR(write(
fd, data.data() + bytes_written_total, size - bytes_written_total));
if (bytes_written_partial < 0)
return false;
}
return true;
}
bool WriteFileDescriptor(int fd, StringPiece data) {
return WriteFileDescriptor(fd, as_bytes(make_span(data)));
}
bool AllocateFileRegion(File* file, int64_t offset, size_t size) {
DCHECK(file);
// Explicitly extend |file| to the maximum size. Zeros will fill the new
// space. It is assumed that the existing file is fully realized as
// otherwise the entire file would have to be read and possibly written.
const int64_t original_file_len = file->GetLength();
if (original_file_len < 0) {
DPLOG(ERROR) << "fstat " << file->GetPlatformFile();
return false;
}
// Increase the actual length of the file, if necessary. This can fail if
// the disk is full and the OS doesn't support sparse files.
const int64_t new_file_len = offset + size;
if (!file->SetLength(std::max(original_file_len, new_file_len))) {
DPLOG(ERROR) << "ftruncate " << file->GetPlatformFile();
return false;
}
// Realize the extent of the file so that it can't fail (and crash) later
// when trying to write to a memory page that can't be created. This can
// fail if the disk is full and the file is sparse.
// First try the more effective platform-specific way of allocating the disk
// space. It can fail because the filesystem doesn't support it. In that case,
// use the manual method below.
#if defined(OS_LINUX) || defined(OS_CHROMEOS)
if (HANDLE_EINTR(fallocate(file->GetPlatformFile(), 0, offset, size)) != -1)
return true;
DPLOG(ERROR) << "fallocate";
#elif defined(OS_APPLE)
// MacOS doesn't support fallocate even though their new APFS filesystem
// does support sparse files. It does, however, have the functionality
// available via fcntl.
// See also: https://openradar.appspot.com/32720223
fstore_t params = {F_ALLOCATEALL, F_PEOFPOSMODE, offset,
static_cast<off_t>(size), 0};
if (fcntl(file->GetPlatformFile(), F_PREALLOCATE, ¶ms) != -1)
return true;
DPLOG(ERROR) << "F_PREALLOCATE";
#endif
// Manually realize the extended file by writing bytes to it at intervals.
int64_t block_size = 512; // Start with something safe.
stat_wrapper_t statbuf;
if (File::Fstat(file->GetPlatformFile(), &statbuf) == 0 &&
statbuf.st_blksize > 0 && base::bits::IsPowerOfTwo(statbuf.st_blksize)) {
block_size = statbuf.st_blksize;
}
// Write starting at the next block boundary after the old file length.
const int64_t extension_start =
base::bits::AlignUp(original_file_len, block_size);
for (int64_t i = extension_start; i < new_file_len; i += block_size) {
char existing_byte;
if (HANDLE_EINTR(pread(file->GetPlatformFile(), &existing_byte, 1, i)) !=
1) {
return false; // Can't read? Not viable.
}
if (existing_byte != 0) {
continue; // Block has data so must already exist.
}
if (HANDLE_EINTR(pwrite(file->GetPlatformFile(), &existing_byte, 1, i)) !=
1) {
return false; // Can't write? Not viable.
}
}
return true;
}
#if !defined(OS_NACL_NONSFI)
bool AppendToFile(const FilePath& filename, span<const uint8_t> data) {
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
bool ret = true;
int fd = HANDLE_EINTR(open(filename.value().c_str(), O_WRONLY | O_APPEND));
if (fd < 0) {
VPLOG(1) << "Unable to create file " << filename.value();
return false;
}
// This call will either write all of the data or return false.
if (!WriteFileDescriptor(fd, data)) {
VPLOG(1) << "Error while writing to file " << filename.value();
ret = false;
}