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
|
/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#include <aws/common/environment.h>
#include <aws/common/file.h>
#include <aws/common/logging.h>
#include <aws/common/string.h>
#include <errno.h>
#include <io.h>
#include <shlwapi.h>
#include <stdio.h>
#include <windows.h>
static bool s_is_string_empty(const struct aws_string *str) {
return str == NULL || str->len == 0;
}
static bool s_is_wstring_empty(const struct aws_wstring *str) {
return str == NULL || str->len == 0;
}
FILE *aws_fopen_safe(const struct aws_string *file_path, const struct aws_string *mode) {
if (s_is_string_empty(file_path)) {
AWS_LOGF_ERROR(AWS_LS_COMMON_IO, "static: Failed to open file. path is empty");
aws_raise_error(AWS_ERROR_FILE_INVALID_PATH);
return NULL;
}
if (s_is_string_empty(mode)) {
AWS_LOGF_ERROR(AWS_LS_COMMON_IO, "static: Failed to open file. mode is empty");
aws_raise_error(AWS_ERROR_INVALID_ARGUMENT);
return NULL;
}
struct aws_wstring *w_file_path = aws_string_convert_to_wstring(aws_default_allocator(), file_path);
struct aws_wstring *w_mode = aws_string_convert_to_wstring(aws_default_allocator(), mode);
FILE *file = NULL;
errno_t error = _wfopen_s(&file, aws_wstring_c_str(w_file_path), aws_wstring_c_str(w_mode));
aws_wstring_destroy(w_mode);
aws_wstring_destroy(w_file_path);
if (error) {
aws_translate_and_raise_io_error_or(error, AWS_ERROR_FILE_OPEN_FAILURE);
AWS_LOGF_ERROR(
AWS_LS_COMMON_IO,
"static: Failed to open file. path:'%s' mode:'%s' errno:%d aws-error:%d(%s)",
aws_string_c_str(file_path),
aws_string_c_str(mode),
error,
aws_last_error(),
aws_error_name(aws_last_error()));
}
return file;
}
struct aws_wstring *s_to_long_path(struct aws_allocator *allocator, const struct aws_wstring *path) {
if (s_is_wstring_empty(path)) {
return NULL;
}
wchar_t prefix[] = L"\\\\?\\";
size_t prefix_size = sizeof(prefix);
if (aws_wstring_num_chars(path) > MAX_PATH - prefix_size) {
struct aws_byte_buf new_path;
aws_byte_buf_init(&new_path, allocator, sizeof(prefix) + path->len + 2);
struct aws_byte_cursor prefix_cur = aws_byte_cursor_from_array((uint8_t *)prefix, sizeof(prefix) - 2);
aws_byte_buf_append_dynamic(&new_path, &prefix_cur);
struct aws_byte_cursor path_cur = aws_byte_cursor_from_array((uint8_t *)aws_wstring_c_str(path), path->len);
aws_byte_buf_append_dynamic(&new_path, &path_cur);
struct aws_wstring *long_path =
aws_wstring_new_from_array(allocator, (wchar_t *)new_path.buffer, new_path.len / sizeof(wchar_t));
aws_byte_buf_clean_up(&new_path);
return long_path;
}
return aws_wstring_new_from_array(allocator, aws_wstring_c_str(path), aws_wstring_num_chars(path));
}
int aws_directory_create(const struct aws_string *dir_path) {
if (s_is_string_empty(dir_path)) {
return aws_raise_error(AWS_ERROR_FILE_INVALID_PATH);
}
struct aws_wstring *w_dir_path = aws_string_convert_to_wstring(aws_default_allocator(), dir_path);
struct aws_wstring *long_dir_path = s_to_long_path(aws_default_allocator(), w_dir_path);
aws_wstring_destroy(w_dir_path);
BOOL create_dir_res = CreateDirectoryW(aws_wstring_c_str(long_dir_path), NULL);
aws_wstring_destroy(long_dir_path);
int error = GetLastError();
if (!create_dir_res) {
if (error == ERROR_ALREADY_EXISTS) {
return AWS_OP_SUCCESS;
}
if (error == ERROR_PATH_NOT_FOUND) {
return aws_raise_error(AWS_ERROR_FILE_INVALID_PATH);
}
if (error == ERROR_ACCESS_DENIED) {
return aws_raise_error(AWS_ERROR_NO_PERMISSION);
}
return aws_raise_error(AWS_ERROR_UNKNOWN);
}
return AWS_OP_SUCCESS;
}
bool aws_directory_exists(const struct aws_string *dir_path) {
if (s_is_string_empty(dir_path)) {
return false;
}
struct aws_wstring *w_dir_path = aws_string_convert_to_wstring(aws_default_allocator(), dir_path);
struct aws_wstring *long_dir_path = s_to_long_path(aws_default_allocator(), w_dir_path);
aws_wstring_destroy(w_dir_path);
DWORD attributes = GetFileAttributesW(aws_wstring_c_str(long_dir_path));
aws_wstring_destroy(long_dir_path);
return (attributes != INVALID_FILE_ATTRIBUTES && (attributes & FILE_ATTRIBUTE_DIRECTORY));
}
static bool s_delete_file_or_directory(const struct aws_directory_entry *entry, void *user_data) {
(void)user_data;
struct aws_allocator *allocator = aws_default_allocator();
struct aws_string *path_str = aws_string_new_from_cursor(allocator, &entry->relative_path);
int ret_val = AWS_OP_SUCCESS;
if (entry->file_type & AWS_FILE_TYPE_FILE) {
ret_val = aws_file_delete(path_str);
}
if (entry->file_type & AWS_FILE_TYPE_DIRECTORY) {
ret_val = aws_directory_delete(path_str, false);
}
aws_string_destroy(path_str);
return ret_val == AWS_OP_SUCCESS;
}
int aws_directory_delete(const struct aws_string *dir_path, bool recursive) {
if (s_is_string_empty(dir_path)) {
return aws_raise_error(AWS_ERROR_FILE_INVALID_PATH);
}
if (!aws_directory_exists(dir_path)) {
return AWS_OP_SUCCESS;
}
int ret_val = AWS_OP_SUCCESS;
if (recursive) {
ret_val = aws_directory_traverse(aws_default_allocator(), dir_path, true, s_delete_file_or_directory, NULL);
}
if (ret_val && aws_last_error() == AWS_ERROR_FILE_INVALID_PATH) {
aws_reset_error();
return AWS_OP_SUCCESS;
}
if (ret_val) {
return AWS_OP_ERR;
}
struct aws_wstring *w_dir_path = aws_string_convert_to_wstring(aws_default_allocator(), dir_path);
struct aws_wstring *long_dir_path = s_to_long_path(aws_default_allocator(), w_dir_path);
aws_wstring_destroy(w_dir_path);
BOOL remove_dir_res = RemoveDirectoryW(aws_wstring_c_str(long_dir_path));
aws_wstring_destroy(long_dir_path);
if (!remove_dir_res) {
int error = GetLastError();
if (error == ERROR_DIR_NOT_EMPTY) {
return aws_raise_error(AWS_ERROR_DIRECTORY_NOT_EMPTY);
}
if (error == ERROR_ACCESS_DENIED) {
return aws_raise_error(AWS_ERROR_NO_PERMISSION);
}
return aws_raise_error(AWS_ERROR_UNKNOWN);
}
return AWS_OP_SUCCESS;
}
int aws_file_delete(const struct aws_string *file_path) {
if (s_is_string_empty(file_path)) {
return aws_raise_error(AWS_ERROR_FILE_INVALID_PATH);
}
struct aws_wstring *w_file_path = aws_string_convert_to_wstring(aws_default_allocator(), file_path);
struct aws_wstring *long_file_path = s_to_long_path(aws_default_allocator(), w_file_path);
aws_wstring_destroy(w_file_path);
BOOL remove_file_res = DeleteFileW(aws_wstring_c_str(long_file_path));
aws_wstring_destroy(long_file_path);
if (!remove_file_res) {
int error = GetLastError();
if (error == ERROR_FILE_NOT_FOUND) {
return AWS_OP_SUCCESS;
}
if (error == ERROR_ACCESS_DENIED) {
return aws_raise_error(AWS_ERROR_NO_PERMISSION);
}
return aws_raise_error(AWS_ERROR_UNKNOWN);
}
return AWS_OP_SUCCESS;
}
int aws_directory_or_file_move(const struct aws_string *from, const struct aws_string *to) {
if (s_is_string_empty(from) || s_is_string_empty(to)) {
return aws_raise_error(AWS_ERROR_FILE_INVALID_PATH);
}
struct aws_wstring *w_from_path = aws_string_convert_to_wstring(aws_default_allocator(), from);
struct aws_wstring *long_from_path = s_to_long_path(aws_default_allocator(), w_from_path);
aws_wstring_destroy(w_from_path);
struct aws_wstring *w_to_path = aws_string_convert_to_wstring(aws_default_allocator(), to);
struct aws_wstring *long_to_path = s_to_long_path(aws_default_allocator(), w_to_path);
aws_wstring_destroy(w_to_path);
BOOL move_res = MoveFileW(aws_wstring_c_str(long_from_path), aws_wstring_c_str(long_to_path));
aws_wstring_destroy(long_from_path);
aws_wstring_destroy(long_to_path);
if (!move_res) {
int error = GetLastError();
if (error == ERROR_FILE_NOT_FOUND) {
return aws_raise_error(AWS_ERROR_FILE_INVALID_PATH);
}
if (error == ERROR_ACCESS_DENIED) {
return aws_raise_error(AWS_ERROR_NO_PERMISSION);
}
return aws_raise_error(AWS_ERROR_UNKNOWN);
}
return AWS_OP_SUCCESS;
}
int aws_directory_traverse(
struct aws_allocator *allocator,
const struct aws_string *path,
bool recursive,
aws_on_directory_entry *on_entry,
void *user_data) {
if (s_is_string_empty(path)) {
return aws_raise_error(AWS_ERROR_FILE_INVALID_PATH);
}
struct aws_wstring *w_path_wchar = aws_string_convert_to_wstring(allocator, path);
struct aws_wstring *long_path_wchar = s_to_long_path(allocator, w_path_wchar);
aws_wstring_destroy(w_path_wchar);
/* windows doesn't fail in FindFirstFile if it's not a directory. Do the check here. We don't call the perfectly
good function for this check because the string is already converted to utf-16 and it's trivial to reuse it. */
DWORD attributes = GetFileAttributesW(aws_wstring_c_str(long_path_wchar));
if (!(attributes & FILE_ATTRIBUTE_DIRECTORY)) {
aws_wstring_destroy(long_path_wchar);
return aws_raise_error(AWS_ERROR_FILE_INVALID_PATH);
}
WIN32_FIND_DATAW ffd;
HANDLE find_handle = FindFirstFileW(aws_wstring_c_str(long_path_wchar), &ffd);
if (find_handle == INVALID_HANDLE_VALUE) {
aws_wstring_destroy(long_path_wchar);
int error = GetLastError();
if (error == ERROR_FILE_NOT_FOUND) {
return aws_raise_error(AWS_ERROR_FILE_INVALID_PATH);
}
return aws_raise_error(AWS_ERROR_UNKNOWN);
}
FindClose(find_handle);
/* create search path string */
struct aws_byte_cursor path_wchar_cur =
aws_byte_cursor_from_array(aws_wstring_c_str(long_path_wchar), aws_wstring_size_bytes(long_path_wchar));
struct aws_byte_buf search_wchar_buf;
aws_byte_buf_init_copy_from_cursor(&search_wchar_buf, allocator, path_wchar_cur);
wchar_t search_wchar_pattern[] = L"\\*";
struct aws_byte_cursor search_char_wchar =
aws_byte_cursor_from_array((uint8_t *)search_wchar_pattern, sizeof(search_wchar_pattern));
aws_byte_buf_append_dynamic(&search_wchar_buf, &search_char_wchar);
struct aws_byte_cursor search_wchar_cur = aws_byte_cursor_from_buf(&search_wchar_buf);
/* it's already converted to wide string */
struct aws_wstring *search_wchar_string = aws_wstring_new_from_cursor(allocator, &search_wchar_cur);
find_handle = FindFirstFileW(aws_wstring_c_str(search_wchar_string), &ffd);
aws_wstring_destroy(search_wchar_string);
aws_byte_buf_clean_up(&search_wchar_buf);
int ret_val = AWS_OP_SUCCESS;
/* iterate each entry in the directory. Do a bunch of utf-16 conversions. Figure out the paths etc....
invoke the visitor, and continue recursing if the flag was set. */
do {
struct aws_string *name_component_multi_char_str =
aws_string_convert_from_wchar_c_str(allocator, ffd.cFileName);
struct aws_byte_cursor name_component_multi_char = aws_byte_cursor_from_string(name_component_multi_char_str);
/* disgard . and .. */
char *ascend_mark = "..";
char *cd_mark = ".";
struct aws_byte_cursor ascend_mark_cur = aws_byte_cursor_from_c_str(ascend_mark);
struct aws_byte_cursor cd_mark_cur = aws_byte_cursor_from_c_str(cd_mark);
if (aws_byte_cursor_eq(&name_component_multi_char, &ascend_mark_cur) ||
aws_byte_cursor_eq(&name_component_multi_char, &cd_mark_cur)) {
aws_string_destroy(name_component_multi_char_str);
continue;
}
/* get the relative path as utf-16, so we can talk to windows. */
struct aws_byte_buf relative_path_wchar;
aws_byte_buf_init_copy_from_cursor(&relative_path_wchar, allocator, path_wchar_cur);
wchar_t unicode_delim[] = L"\\";
struct aws_byte_cursor delimiter_cur =
aws_byte_cursor_from_array((uint8_t *)unicode_delim, sizeof(unicode_delim) - 2);
aws_byte_buf_append_dynamic(&relative_path_wchar, &delimiter_cur);
struct aws_byte_cursor name_str =
aws_byte_cursor_from_array(ffd.cFileName, wcsnlen(ffd.cFileName, sizeof(ffd.cFileName)) * sizeof(wchar_t));
aws_byte_buf_append_dynamic(&relative_path_wchar, &name_str);
aws_byte_buf_append_byte_dynamic(&relative_path_wchar, 0);
aws_byte_buf_append_byte_dynamic(&relative_path_wchar, 0);
relative_path_wchar.len -= 2;
/* now get the absolute path from the relative path we just computed. */
DWORD path_res = GetFullPathNameW((wchar_t *)relative_path_wchar.buffer, 0, NULL, NULL);
AWS_FATAL_ASSERT(path_res > 0);
struct aws_byte_buf full_path_wchar_buf;
aws_byte_buf_init(&full_path_wchar_buf, allocator, (size_t)path_res * sizeof(wchar_t) + 2);
full_path_wchar_buf.len = full_path_wchar_buf.capacity - 2;
path_res = GetFullPathNameW(
(wchar_t *)relative_path_wchar.buffer, (DWORD)path_res + 1, (wchar_t *)full_path_wchar_buf.buffer, NULL);
AWS_FATAL_ASSERT(path_res > 0);
aws_byte_buf_append_byte_dynamic(&full_path_wchar_buf, 0);
aws_byte_buf_append_byte_dynamic(&full_path_wchar_buf, 0);
/* now we have the data, convert the utf-16 strings we used to communicate with windows back to
utf-8 for the user to actually consume. */
struct aws_string *full_path_name_multi_char =
aws_string_convert_from_wchar_c_str(allocator, (wchar_t *)full_path_wchar_buf.buffer);
aws_byte_buf_clean_up(&full_path_wchar_buf);
struct aws_string *relative_path_multi_char =
aws_string_convert_from_wchar_c_str(allocator, (wchar_t *)relative_path_wchar.buffer);
struct aws_directory_entry entry;
AWS_ZERO_STRUCT(entry);
entry.relative_path = aws_byte_cursor_from_string(relative_path_multi_char);
entry.path = aws_byte_cursor_from_string(full_path_name_multi_char);
LARGE_INTEGER file_size;
file_size.HighPart = ffd.nFileSizeHigh;
file_size.LowPart = ffd.nFileSizeLow;
entry.file_size = (int64_t)file_size.QuadPart;
if (ffd.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) {
entry.file_type |= AWS_FILE_TYPE_DIRECTORY;
} else {
entry.file_type |= AWS_FILE_TYPE_FILE;
}
if (recursive && entry.file_type & AWS_FILE_TYPE_DIRECTORY) {
ret_val = aws_directory_traverse(allocator, relative_path_multi_char, recursive, on_entry, user_data);
}
/* post order traversal, if a node below us ended the traversal, don't call the visitor again. */
if (ret_val && aws_last_error() == AWS_ERROR_OPERATION_INTERUPTED) {
goto cleanup;
}
if (!on_entry(&entry, user_data)) {
ret_val = aws_raise_error(AWS_ERROR_OPERATION_INTERUPTED);
goto cleanup;
}
if (ret_val) {
goto cleanup;
}
cleanup:
aws_string_destroy(relative_path_multi_char);
aws_string_destroy(full_path_name_multi_char);
aws_byte_buf_clean_up(&relative_path_wchar);
aws_string_destroy(name_component_multi_char_str);
} while (ret_val == AWS_OP_SUCCESS && FindNextFileW(find_handle, &ffd));
aws_wstring_destroy(long_path_wchar);
if (find_handle != INVALID_HANDLE_VALUE) {
FindClose(find_handle);
}
return ret_val;
}
char aws_get_platform_directory_separator(void) {
return '\\';
}
AWS_STATIC_STRING_FROM_LITERAL(s_userprofile_env_var, "USERPROFILE");
AWS_STATIC_STRING_FROM_LITERAL(s_homedrive_env_var, "HOMEDRIVE");
AWS_STATIC_STRING_FROM_LITERAL(s_homepath_env_var, "HOMEPATH");
AWS_STATIC_STRING_FROM_LITERAL(s_home_env_var, "HOME");
struct aws_string *aws_get_home_directory(struct aws_allocator *allocator) {
/*
* 1. Check HOME
*/
struct aws_string *home_env_var_value = NULL;
if (aws_get_environment_value(allocator, s_home_env_var, &home_env_var_value) == 0 && home_env_var_value != NULL) {
return home_env_var_value;
}
/*
* 2. (Windows) Check USERPROFILE
*/
struct aws_string *userprofile_env_var_value = NULL;
if (aws_get_environment_value(allocator, s_userprofile_env_var, &userprofile_env_var_value) == 0 &&
userprofile_env_var_value != NULL) {
return userprofile_env_var_value;
}
/*
* 3. (Windows) Check HOMEDRIVE ++ HOMEPATH
*/
struct aws_string *final_path = NULL;
struct aws_string *homedrive_env_var_value = NULL;
if (aws_get_environment_value(allocator, s_homedrive_env_var, &homedrive_env_var_value) == 0 &&
homedrive_env_var_value != NULL) {
struct aws_string *homepath_env_var_value = NULL;
if (aws_get_environment_value(allocator, s_homepath_env_var, &homepath_env_var_value) == 0 &&
homepath_env_var_value != NULL) {
struct aws_byte_buf concatenated_dir;
aws_byte_buf_init(
&concatenated_dir, allocator, homedrive_env_var_value->len + homepath_env_var_value->len + 1);
struct aws_byte_cursor drive_cursor = aws_byte_cursor_from_string(homedrive_env_var_value);
struct aws_byte_cursor path_cursor = aws_byte_cursor_from_string(homepath_env_var_value);
aws_byte_buf_append(&concatenated_dir, &drive_cursor);
aws_byte_buf_append(&concatenated_dir, &path_cursor);
final_path = aws_string_new_from_buf(allocator, &concatenated_dir);
aws_byte_buf_clean_up(&concatenated_dir);
aws_string_destroy(homepath_env_var_value);
}
aws_string_destroy(homedrive_env_var_value);
}
if (final_path != NULL) {
return final_path;
}
return NULL;
}
bool aws_path_exists(const struct aws_string *path) {
if (s_is_string_empty(path)) {
return false;
}
struct aws_wstring *wchar_path = aws_string_convert_to_wstring(aws_default_allocator(), path);
bool ret_val = PathFileExistsW(aws_wstring_c_str(wchar_path)) == TRUE;
aws_wstring_destroy(wchar_path);
return ret_val;
}
int aws_fseek(FILE *file, int64_t offset, int whence) {
if (_fseeki64(file, offset, whence)) {
int errno_value = errno; /* Always cache errno before potential side-effect */
return aws_translate_and_raise_io_error_or(errno_value, AWS_ERROR_STREAM_UNSEEKABLE);
}
return AWS_OP_SUCCESS;
}
int aws_file_get_length(FILE *file, int64_t *length) {
if (file == NULL) {
return aws_raise_error(AWS_ERROR_INVALID_FILE_HANDLE);
}
int fd = _fileno(file);
if (fd == -1) {
return aws_raise_error(AWS_ERROR_INVALID_FILE_HANDLE);
}
HANDLE os_file = (HANDLE)_get_osfhandle(fd);
if (os_file == INVALID_HANDLE_VALUE) {
int errno_value = errno; /* Always cache errno before potential side-effect */
return aws_translate_and_raise_io_error(errno_value);
}
LARGE_INTEGER os_size;
if (!GetFileSizeEx(os_file, &os_size)) {
return aws_raise_error(AWS_ERROR_SYS_CALL_FAILURE);
}
int64_t size = os_size.QuadPart;
if (size < 0) {
return aws_raise_error(AWS_ERROR_SYS_CALL_FAILURE);
}
*length = size;
return AWS_OP_SUCCESS;
}
|