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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifdef UNSAFE_BUFFERS_BUILD
// TODO(crbug.com/390223051): Remove C-library calls to fix the errors.
#pragma allow_unsafe_libc_calls
#endif
#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 <bit>
#include <iomanip>
#include <memory>
#include <optional>
#include <string_view>
#include "base/base_export.h"
#include "base/base_switches.h"
#include "base/bits.h"
#include "base/command_line.h"
#include "base/containers/adapters.h"
#include "base/containers/contains.h"
#include "base/containers/heap_array.h"
#include "base/containers/stack.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/notreached.h"
#include "base/numerics/safe_conversions.h"
#include "base/path_service.h"
#include "base/posix/eintr_wrapper.h"
#include "base/strings/cstring_view.h"
#include "base/strings/strcat.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"
#if BUILDFLAG(IS_APPLE)
#include <AvailabilityMacros.h>
#include "base/apple/foundation_util.h"
#endif
#if BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS) || BUILDFLAG(IS_ANDROID)
#include <sys/sendfile.h>
#endif
#if BUILDFLAG(IS_ANDROID)
#include "base/android/content_uri_utils.h"
#include "base/os_compat_android.h"
#endif
#if !BUILDFLAG(IS_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 BUILDFLAG(IS_AIX)
extern "C" char* mkdtemp(char* path);
#endif
namespace base {
namespace {
#if BUILDFLAG(IS_MAC)
// 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, &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;
}
#endif
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, &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 BUILDFLAG(IS_APPLE)
mode_t mode = 0600 | (stat_at_use.st_mode & 0177);
#elif BUILDFLAG(IS_CHROMEOS)
mode_t mode = 0644;
#else
mode_t 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;
}
struct CloseDir {
void operator()(DIR* const p) const {
if (IGNORE_EINTR(closedir(p)) < 0) {
PLOG(ERROR) << "Cannot close dir";
}
}
};
// Deletes the file or removes the directory specified by `path` and `at_fd`. If
// `path` is absolute, then `at_fd` is simply ignored. If `path` is relative,
// then it is considered relative to the directory designated by the file
// descriptor `at_fd`. If `path` is relative and `at_fd` has the special value
// AT_FDCWD, then `path` is considered relative to the current working directory
// of the running process.
bool DoDeleteFile(const PlatformFile at_fd,
const char* const path,
const bool recursive) {
// Get info about item to remove.
stat_wrapper_t st;
if (HANDLE_EINTR(fstatat(at_fd, path, &st, AT_SYMLINK_NOFOLLOW)) < 0) {
VPLOG(1) << "Cannot stat " << std::quoted(path);
return errno == ENOENT;
}
// Check if it is a directory or a file.
if (!S_ISDIR(st.st_mode)) {
// It is a file or a symlink. Delete it.
const bool deleted = unlinkat(at_fd, path, 0) == 0;
VPLOG_IF(1, !deleted) << "Cannot delete " << std::quoted(path);
return deleted || errno == ENOENT;
}
// It is a directory.
if (recursive) {
// Recursively empty the directory.
// Open the directory.
const PlatformFile fd = HANDLE_EINTR(
openat(at_fd, path, O_RDONLY | O_DIRECTORY | O_NOFOLLOW | O_CLOEXEC));
if (fd < 0) {
VPLOG(1) << "Cannot open dir " << std::quoted(path);
return false;
}
// Create a DIR object from the directory file descriptor.
// This transfers the ownership of `fd` to `dir` in case of success.
const std::unique_ptr<DIR, CloseDir> dir(fdopendir(fd));
if (!dir) {
VPLOG(1) << "Cannot start reading dir " << std::quoted(path);
IGNORE_EINTR(close(fd));
return false;
}
// Check all the items in the directory.
while (true) {
errno = 0;
const dirent* const entry = readdir(dir.get());
if (!entry) {
break;
}
// Recursively delete the found item.
if (const std::string_view s = entry->d_name;
s != "." && s != ".." && !DoDeleteFile(fd, entry->d_name, true)) {
return false;
}
}
// Finished enumerating the items in the directory.
if (errno != 0) {
VPLOG(1) << "Cannot read dir " << std::quoted(path);
return false;
}
}
// Remove the (now possibly empty) directory.
const bool removed = unlinkat(at_fd, path, AT_REMOVEDIR) == 0;
VPLOG_IF(1, !removed) << "Cannot remove " << std::quoted(path);
return removed || errno == ENOENT;
}
// 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 BUILDFLAG(IS_ANDROID)
if (path.IsContentUri()) {
return internal::DeleteContentUri(path);
}
#endif // BUILDFLAG(IS_ANDROID)
return DoDeleteFile(AT_FDCWD, path.value().c_str(), recursive);
}
#if !BUILDFLAG(IS_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(std::string_view 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
#if !BUILDFLAG(IS_LINUX) && !BUILDFLAG(IS_CHROMEOS) && !BUILDFLAG(IS_APPLE) && \
!(BUILDFLAG(IS_ANDROID) && __ANDROID_API__ >= 21)
bool PreReadFileSlow(const FilePath& file_path, int64_t max_bytes) {
DCHECK_GE(max_bytes, 0);
File file(file_path, File::FLAG_OPEN | File::FLAG_READ);
if (!file.IsValid()) {
return false;
}
constexpr size_t kBufferSize = 1024 * 1024;
auto buffer = base::HeapArray<uint8_t>::Uninit(kBufferSize);
while (max_bytes > 0) {
const size_t read_size = base::checked_cast<size_t>(
std::min<uint64_t>(static_cast<uint64_t>(max_bytes), buffer.size()));
std::optional<size_t> read_bytes =
file.ReadAtCurrentPos(buffer.first(read_size));
if (!read_bytes.has_value()) {
return false;
}
if (read_bytes.value() == 0) {
break;
}
max_bytes -= read_bytes.value();
}
return true;
}
#endif
#if BUILDFLAG(IS_CHROMEOS)
// Checks if the given path is under ~/MyFiles or /media.
// Recognizes the following patterns:
// - "/home/chronos/user/MyFiles/<dir>[/...]"
// - "/home/chronos/u-<id>/MyFiles/<dir>[/...]"
// - "/media/<dir>[/...]"
bool IsVisibleToUser(const FilePath& path) {
if (!path.IsAbsolute()) {
return false;
}
const std::vector parts = path.GetComponents();
// Since the path is absolute, the first part should be the root directory.
DCHECK(!parts.empty());
DCHECK_EQ(parts[0], "/");
// Is path under /media?
if (parts.size() > 2 && parts[1] == "media" && !parts[2].empty()) {
return true;
}
// Is path under ~/MyFiles?
return parts.size() > 5 && parts[1] == "home" && parts[2] == "chronos" &&
(parts[3] == "user" ||
(parts[3].starts_with("u-") && parts[3].size() > 2)) &&
parts[4] == "MyFiles" && !parts[5].empty();
}
#endif // BUILDFLAG(IS_CHROMEOS)
} // namespace
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);
}
std::optional<FilePath> MakeAbsoluteFilePathNoResolveSymbolicLinks(
const FilePath& input) {
if (input.empty()) {
return std::nullopt;
}
FilePath collapsed_path;
std::vector<FilePath::StringType> components = input.GetComponents();
base::span<FilePath::StringType> components_span(components);
// Start with root for absolute |input| and the current working directory for
// a relative |input|.
if (input.IsAbsolute()) {
collapsed_path = FilePath(components_span[0]);
components_span = components_span.subspan<1>();
} else {
if (!GetCurrentDirectory(&collapsed_path)) {
return std::nullopt;
}
}
for (const auto& component : components_span) {
if (component == FilePath::kCurrentDirectory) {
continue;
}
if (component == FilePath::kParentDirectory) {
// Pop the most recent component off the FilePath. Works correctly when
// the FilePath is root.
collapsed_path = collapsed_path.DirName();
continue;
}
// This is just a regular component. Append it.
collapsed_path = collapsed_path.Append(component);
}
return collapsed_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);
}
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(span<int, 2u> fds) {
#if BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS)
return pipe2(fds.data(), O_CLOEXEC | O_NONBLOCK) == 0;
#else
std::array<int, 2> raw_fds;
if (pipe(raw_fds.data()) != 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[0u] = fd_out.release();
fds[1u] = 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 (fcntl(fd, F_SETFL, flags | O_NONBLOCK) == -1) {
return false;
}
return true;
}
bool SetCloseOnExec(int fd) {
const int flags = fcntl(fd, F_GETFD);
if (flags == -1) {
return false;
}
if (flags & FD_CLOEXEC) {
return true;
}
if (fcntl(fd, F_SETFD, flags | FD_CLOEXEC) == -1) {
return false;
}
return true;
}
bool RemoveCloseOnExec(int fd) {
const int flags = fcntl(fd, F_GETFD);
if (flags == -1) {
return false;
}
if ((flags & FD_CLOEXEC) == 0) {
return true;
}
if (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 BUILDFLAG(IS_ANDROID)
if (path.IsContentUri()) {
return internal::ContentUriExists(path);
}
#endif
return access(path.value().c_str(), F_OK) == 0;
}
bool PathIsReadable(const FilePath& path) {
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
return access(path.value().c_str(), R_OK) == 0;
}
bool PathIsWritable(const FilePath& path) {
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
return access(path.value().c_str(), W_OK) == 0;
}
bool DirectoryExists(const FilePath& path) {
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
stat_wrapper_t file_info;
if (File::Stat(path, &file_info) != 0) {
return false;
}
return S_ISDIR(file_info.st_mode);
}
bool ReadFromFD(int fd, span<char> buffer) {
while (!buffer.empty()) {
ssize_t bytes_read = HANDLE_EINTR(read(fd, buffer.data(), buffer.size()));
if (bytes_read <= 0) {
return false;
}
buffer = buffer.subspan(static_cast<size_t>(bytes_read));
}
return true;
}
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 !BUILDFLAG(IS_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, std::size(buf));
#if BUILDFLAG(IS_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, static_cast<size_t>(count)));
return true;
}
std::optional<FilePath> ReadSymbolicLinkAbsolute(const FilePath& symlink_path) {
FilePath target_path;
if (!ReadSymbolicLink(symlink_path, &target_path)) {
return std::nullopt;
}
// Relative symbolic links are relative to the symlink's directory.
if (!target_path.IsAbsolute()) {
target_path = symlink_path.DirName().Append(target_path);
}
// Remove "/./" and "/../" to make this more friendly to path-allowlist-based
// sandboxes.
return MakeAbsoluteFilePathNoResolveSymbolicLinks(target_path);
}
bool GetPosixFilePermissions(const FilePath& path, int* mode) {
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
DCHECK(mode);
#if BUILDFLAG(IS_ANDROID)
// Stat() for content URIs only implements dir bit currently, so fail for
// GetPosixFilePermissions() until permissions are implemented.
if (path.IsContentUri()) {
return false;
}
#endif
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, &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, &stat_buf) != 0) {
return false;
}
// Clears the existing permission bits, and adds the new ones.
// The casting here is because the Android NDK does not declare `st_mode` as a
// `mode_t`.
mode_t updated_mode_bits = static_cast<mode_t>(stat_buf.st_mode);
updated_mode_bits &= static_cast<mode_t>(~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 = env->GetVar("PATH").value_or("");
if (path.empty()) {
LOG(ERROR) << "No $PATH variable. Assuming no " << executable << ".";
return false;
}
for (std::string_view 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 // !BUILDFLAG(IS_FUCHSIA)
#if !BUILDFLAG(IS_APPLE)
// This is implemented in file_util_apple.mm for Mac.
bool GetTempDir(FilePath* path) {
const char* tmp = getenv("TMPDIR");
if (tmp) {
*path = FilePath(tmp);
return true;
}
#if BUILDFLAG(IS_ANDROID)
return PathService::Get(DIR_CACHE, path);
#else
*path = FilePath("/tmp");
return true;
#endif
}
#endif // !BUILDFLAG(IS_APPLE)
#if !BUILDFLAG(IS_APPLE) // Mac implementation is in file_util_apple.mm.
FilePath GetHomeDir() {
#if BUILDFLAG(IS_CHROMEOS)
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 BUILDFLAG(IS_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 // !BUILDFLAG(IS_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::StringViewType identifier) {
#if BUILDFLAG(IS_APPLE)
std::string_view prefix = base::apple::BaseBundleID();
#elif BUILDFLAG(GOOGLE_CHROME_BRANDING)
std::string_view prefix = "com.google.Chrome";
#else
std::string_view 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,
FilePath::StringViewType 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().
// Avoid checking subdirs if directory already exists.
if (DirectoryExists(full_path)) {
return true;
}
// Collect a list of all missing directories.
std::vector<FilePath> missing_subpaths({full_path});
FilePath last_path = full_path;
for (FilePath path = full_path.DirName(); path.value() != last_path.value();
path = path.DirName()) {
if (DirectoryExists(path)) {
break;
}
missing_subpaths.push_back(path);
last_path = path;
}
// Iterate through the missing directories and create.
for (const FilePath& subpath : base::Reversed(missing_subpaths)) {
mode_t mode = S_IRWXU;
#if BUILDFLAG(IS_CHROMEOS)
if (IsVisibleToUser(subpath)) {
mode |= S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH;
}
#endif // BUILDFLAG(IS_CHROMEOS)
if (mkdir(subpath.value().c_str(), mode) == 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(subpath)) {
if (error) {
*error = File::OSErrorToFileError(saved_errno);
}
errno = 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();
const int flags = O_CLOEXEC | O_NONBLOCK | O_RDONLY | O_NOCTTY;
base::ScopedFD fd(HANDLE_EINTR(open(file.MaybeAsASCII().c_str(), flags)));
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;
}
if (bytes_read > 0) {
ret->append(buf, static_cast<size_t>(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;
}
*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, &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 (File::Stat(file_path, &file_info) != 0) {
return false;
}
results->FromStat(file_info);
return true;
}
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 BUILDFLAG(IS_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 BUILDFLAG(IS_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 !BUILDFLAG(IS_NACL)
FILE* FileToFILE(File file, const char* mode) {
PlatformFile unowned = file.GetPlatformFile();
FILE* stream = fdopen(file.TakePlatformFile(), mode);
if (!stream) {
ScopedFD to_be_closed(unowned);
}
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 // !BUILDFLAG(IS_NACL)
std::optional<uint64_t> ReadFile(const FilePath& filename, span<char> buffer) {
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
int fd = HANDLE_EINTR(open(filename.value().c_str(), O_RDONLY));
if (fd < 0) {
return std::nullopt;
}
// TODO(crbug.com/40227936): Consider supporting reading more than INT_MAX
// bytes.
size_t bytes_to_read = static_cast<size_t>(checked_cast<int>(buffer.size()));
ssize_t bytes_read = HANDLE_EINTR(read(fd, buffer.data(), bytes_to_read));
if (IGNORE_EINTR(close(fd)) < 0) {
return std::nullopt;
}
if (bytes_read < 0) {
return std::nullopt;
}
static_assert(SSIZE_MAX <= UINT64_MAX);
return bytes_read;
}
bool WriteFile(const FilePath& filename, span<const uint8_t> data) {
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
int fd = HANDLE_EINTR(creat(filename.value().c_str(), 0666));
if (fd < 0) {
return false;
}
bool success = WriteFileDescriptor(fd, data);
if (IGNORE_EINTR(close(fd)) < 0) {
return false;
}
return success;
}
bool WriteFileDescriptor(int fd, span<const uint8_t> data) {
while (!data.empty()) {
ssize_t bytes_written_partial =
HANDLE_EINTR(write(fd, data.data(), data.size()));
if (bytes_written_partial < 0) {
return false;
}
data = data.subspan(checked_cast<size_t>(bytes_written_partial));
}
return true;
}
bool WriteFileDescriptor(int fd, std::string_view data) {
return WriteFileDescriptor(fd, as_byte_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 + static_cast<int64_t>(size);
// If the first condition fails, the cast on the previous line was invalid
// (though not UB).
if (!IsValueInRangeForNumericType<int64_t>(size) ||
!IsValueInRangeForNumericType<off_t>(size) ||
!IsValueInRangeForNumericType<off_t>(new_file_len) ||
!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 BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS)
if (HANDLE_EINTR(fallocate(file->GetPlatformFile(), 0, offset,
static_cast<off_t>(size))) != -1) {
return true;
}
DPLOG(ERROR) << "fallocate";
#elif BUILDFLAG(IS_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.
blksize_t block_size = 512; // Start with something safe.
stat_wrapper_t statbuf;
if (File::Fstat(file->GetPlatformFile(), &statbuf) == 0 &&
statbuf.st_blksize > 0 &&
std::has_single_bit(base::checked_cast<uint64_t>(statbuf.st_blksize))) {
block_size = static_cast<blksize_t>(statbuf.st_blksize);
}
// Write starting at the next block boundary after the old file length.
const int64_t extension_start = checked_cast<int64_t>(base::bits::AlignUp(
static_cast<size_t>(original_file_len), static_cast<size_t>(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,
static_cast<off_t>(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,
static_cast<off_t>(i))) != 1) {
return false; // Can't write? Not viable.
}
}
return true;
}
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;
}
if (IGNORE_EINTR(close(fd)) < 0) {
VPLOG(1) << "Error while closing file " << filename.value();
return false;
}
return ret;
}
bool AppendToFile(const FilePath& filename, std::string_view data) {
return AppendToFile(filename, as_byte_span(data));
}
bool GetCurrentDirectory(FilePath* dir) {
// getcwd can return ENOENT, which implies it checks against the disk.
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
char system_buffer[PATH_MAX] = "";
if (!getcwd(system_buffer, sizeof(system_buffer))) {
return false;
}
*dir = FilePath(system_buffer);
return true;
}
bool SetCurrentDirectory(const FilePath& path) {
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
return chdir(path.value().c_str()) == 0;
}
#if BUILDFLAG(IS_MAC)
bool VerifyPathControlledByUser(const FilePath& base,
const FilePath& path,
uid_t owner_uid,
const std::set<gid_t>& group_gids) {
if (base != path && !base.IsParent(path)) {
DLOG(ERROR) << "|base| must be a subdirectory of |path|. base = \""
<< base.value() << "\", path = \"" << path.value() << "\"";
return false;
}
std::vector<FilePath::StringType> base_components = base.GetComponents();
std::vector<FilePath::StringType> path_components = path.GetComponents();
std::vector<FilePath::StringType>::const_iterator ib, ip;
for (ib = base_components.begin(), ip = path_components.begin();
ib != base_components.end(); ++ib, ++ip) {
// |base| must be a subpath of |path|, so all components should match.
// If these CHECKs fail, look at the test that base is a parent of
// path at the top of this function.
CHECK(ip != path_components.end());
DCHECK(*ip == *ib);
}
FilePath current_path = base;
if (!VerifySpecificPathControlledByUser(current_path, owner_uid,
group_gids)) {
return false;
}
for (; ip != path_components.end(); ++ip) {
current_path = current_path.Append(*ip);
if (!VerifySpecificPathControlledByUser(current_path, owner_uid,
group_gids)) {
return false;
}
}
return true;
}
bool VerifyPathControlledByAdmin(const FilePath& path) {
constexpr unsigned kRootUid = 0;
const FilePath kFileSystemRoot("/");
// The name of the administrator group on mac os.
const char* const kAdminGroupNames[] = {"admin", "wheel"};
// Reading the groups database may touch the file system.
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
std::set<gid_t> allowed_group_ids;
for (const char* name : kAdminGroupNames) {
struct group* group_record = getgrnam(name);
if (!group_record) {
DPLOG(ERROR) << "Could not get the group ID of group \"" << name << "\".";
continue;
}
allowed_group_ids.insert(group_record->gr_gid);
}
return VerifyPathControlledByUser(kFileSystemRoot, path, kRootUid,
allowed_group_ids);
}
#endif // BUILDFLAG(IS_MAC)
int GetMaximumPathComponentLength(const FilePath& path) {
#if BUILDFLAG(IS_FUCHSIA)
// Return a value we do not expect anyone ever to reach, but which is small
// enough to guard against e.g. bugs causing multi-megabyte paths.
return 1024;
#else
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
return saturated_cast<int>(pathconf(path.value().c_str(), _PC_NAME_MAX));
#endif
}
#if !BUILDFLAG(IS_ANDROID)
// This is implemented in file_util_android.cc for that platform.
bool GetShmemTempDir(bool executable, FilePath* path) {
#if BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS) || BUILDFLAG(IS_AIX)
bool disable_dev_shm = false;
#if !BUILDFLAG(IS_CHROMEOS)
disable_dev_shm = CommandLine::ForCurrentProcess()->HasSwitch(
switches::kDisableDevShmUsage);
#endif
bool use_dev_shm = true;
if (executable) {
static const bool s_dev_shm_executable =
IsPathExecutable(FilePath("/dev/shm"));
use_dev_shm = s_dev_shm_executable;
}
if (use_dev_shm && !disable_dev_shm) {
*path = FilePath("/dev/shm");
return true;
}
#endif // BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS) || BUILDFLAG(IS_AIX)
return GetTempDir(path);
}
#endif // !BUILDFLAG(IS_ANDROID)
#if !BUILDFLAG(IS_APPLE)
// Mac has its own implementation, this is for all other Posix systems.
bool CopyFile(const FilePath& from_path, const FilePath& to_path) {
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
File infile(from_path, File::FLAG_OPEN | File::FLAG_READ);
if (!infile.IsValid()) {
return false;
}
File outfile(to_path, File::FLAG_WRITE | File::FLAG_CREATE_ALWAYS);
if (!outfile.IsValid()) {
return false;
}
return CopyFileContents(infile, outfile);
}
#endif // !BUILDFLAG(IS_APPLE)
bool PreReadFile(const FilePath& file_path,
bool is_executable,
bool sequential,
int64_t max_bytes) {
DCHECK_GE(max_bytes, 0);
// posix_fadvise() is only available in the Android NDK in API 21+. Older
// versions may have the required kernel support, but don't have enough usage
// to justify backporting.
#if BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS) || \
(BUILDFLAG(IS_ANDROID) && __ANDROID_API__ >= 21)
File file(file_path, File::FLAG_OPEN | File::FLAG_READ);
if (!file.IsValid()) {
return false;
}
if (max_bytes == 0) {
// fadvise() pre-fetches the entire file when given a zero length.
return true;
}
const PlatformFile fd = file.GetPlatformFile();
const ::off_t len = base::saturated_cast<::off_t>(max_bytes);
const int advice = sequential ? POSIX_FADV_SEQUENTIAL : POSIX_FADV_WILLNEED;
return posix_fadvise(fd, /*offset=*/0, len, advice) == 0;
#elif BUILDFLAG(IS_APPLE)
File file(file_path, File::FLAG_OPEN | File::FLAG_READ);
if (!file.IsValid()) {
return false;
}
if (max_bytes == 0) {
// fcntl(F_RDADVISE) fails when given a zero length.
return true;
}
const PlatformFile fd = file.GetPlatformFile();
::radvisory read_advise_data = {
.ra_offset = 0, .ra_count = base::saturated_cast<int>(max_bytes)};
return fcntl(fd, F_RDADVISE, &read_advise_data) != -1;
#else
return PreReadFileSlow(file_path, max_bytes);
#endif // BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS) ||
// (BUILDFLAG(IS_ANDROID) &&
// __ANDROID_API__ >= 21)
}
// -----------------------------------------------------------------------------
namespace internal {
bool MoveUnsafe(const FilePath& from_path, const FilePath& to_path) {
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
// Windows compatibility: if |to_path| exists, |from_path| and |to_path|
// must be the same type, either both files, or both directories.
stat_wrapper_t to_file_info;
if (File::Stat(to_path, &to_file_info) == 0) {
stat_wrapper_t from_file_info;
if (File::Stat(from_path, &from_file_info) != 0) {
return false;
}
if (S_ISDIR(to_file_info.st_mode) != S_ISDIR(from_file_info.st_mode)) {
return false;
}
}
if (rename(from_path.value().c_str(), to_path.value().c_str()) == 0) {
return true;
}
if (!CopyDirectory(from_path, to_path, true)) {
return false;
}
DeletePathRecursively(from_path);
return true;
}
#if BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS) || BUILDFLAG(IS_ANDROID)
bool CopyFileContentsWithSendfile(File& infile,
File& outfile,
bool& retry_slow) {
DCHECK(infile.IsValid());
stat_wrapper_t in_file_info;
retry_slow = false;
if (base::File::Fstat(infile.GetPlatformFile(), &in_file_info)) {
return false;
}
int64_t file_size = in_file_info.st_size;
if (file_size < 0) {
return false;
}
if (file_size == 0) {
// Non-regular files can return a file size of 0, things such as pipes,
// sockets, etc. Additionally, kernel seq_files(most procfs files) will also
// return 0 while still reporting as a regular file. Unfortunately, in some
// of these situations there are easy ways to detect them, in others there
// are not. No extra syscalls are needed if it's not a regular file.
//
// Because any attempt to detect it would likely require another syscall,
// let's just fall back to a slow copy which will invoke a single read(2) to
// determine if the file has contents or if it's really a zero length file.
retry_slow = true;
return false;
}
size_t copied = 0;
ssize_t res = 0;
do {
// Don't specify an offset and the kernel will begin reading/writing to the
// current file offsets.
res = HANDLE_EINTR(sendfile(
outfile.GetPlatformFile(), infile.GetPlatformFile(), /*offset=*/nullptr,
/*length=*/static_cast<size_t>(file_size) - copied));
if (res <= 0) {
break;
}
copied += static_cast<size_t>(res);
} while (copied < static_cast<size_t>(file_size));
// Fallback on non-fatal error cases. None of these errors can happen after
// data has started copying, a check is included for good measure. As a result
// file sizes and file offsets will not have changed. A slow fallback and
// proceed without issues.
retry_slow = (copied == 0 && res < 0 &&
(errno == EINVAL || errno == ENOSYS || errno == EPERM));
return res >= 0;
}
#endif // BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS) ||
// BUILDFLAG(IS_ANDROID)
} // namespace internal
#if BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS) || BUILDFLAG(IS_AIX)
BASE_EXPORT bool IsPathExecutable(const FilePath& path) {
bool result = false;
FilePath tmp_file_path;
ScopedFD fd = CreateAndOpenFdForTemporaryFileInDir(path, &tmp_file_path);
if (fd.is_valid()) {
DeleteFile(tmp_file_path);
long sysconf_result = sysconf(_SC_PAGESIZE);
CHECK_GE(sysconf_result, 0);
size_t pagesize = static_cast<size_t>(sysconf_result);
CHECK_GE(sizeof(pagesize), sizeof(sysconf_result));
void* mapping = mmap(nullptr, pagesize, PROT_READ, MAP_SHARED, fd.get(), 0);
if (mapping != MAP_FAILED) {
if (HANDLE_EINTR(mprotect(mapping, pagesize, PROT_READ | PROT_EXEC)) ==
0) {
result = true;
}
munmap(mapping, pagesize);
}
}
return result;
}
#endif // BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS) || BUILDFLAG(IS_AIX)
} // namespace base
|