wimlib.net Git - wimlib/blob - src/win32.c

   1 /*
   2  * win32.c
   3  *
   4  * All the library code specific to native Windows builds is in here.
   5  */
   6
   7 /*
   8  * Copyright (C) 2013 Eric Biggers
   9  *
  10  * This file is part of wimlib, a library for working with WIM files.
  11  *
  12  * wimlib is free software; you can redistribute it and/or modify it under the
  13  * terms of the GNU General Public License as published by the Free
  14  * Software Foundation; either version 3 of the License, or (at your option)
  15  * any later version.
  16  *
  17  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
  18  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  19  * A PARTICULAR PURPOSE. See the GNU General Public License for more
  20  * details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with wimlib; if not, see http://www.gnu.org/licenses/.
  24  */
  25
  26 #ifdef __WIN32__
  27
  28 #include "config.h"
  29 #include <windows.h>
  30 #include <ntdef.h>
  31 #include <wchar.h>
  32 #include <shlwapi.h> /* shlwapi.h for PathMatchSpecW() */
  33 #ifdef ERROR /* windows.h defines this */
  34 #  undef ERROR
  35 #endif
  36
  37 #include "win32.h"
  38 #include "dentry.h"
  39 #include "lookup_table.h"
  40 #include "security.h"
  41 #include "endianness.h"
  42 #include "buffer_io.h"
  43 #include <pthread.h>
  44
  45 #include <errno.h>
  46
  47 #define MAX_GET_SD_ACCESS_DENIED_WARNINGS 1
  48 #define MAX_GET_SACL_PRIV_NOTHELD_WARNINGS 1
  49 #define MAX_CREATE_HARD_LINK_WARNINGS 5
  50 struct win32_capture_state {
  51         unsigned long num_get_sd_access_denied;
  52         unsigned long num_get_sacl_priv_notheld;
  53 };
  54
  55 #define MAX_SET_SD_ACCESS_DENIED_WARNINGS 1
  56 #define MAX_SET_SACL_PRIV_NOTHELD_WARNINGS 1
  57
  58 #ifdef ENABLE_ERROR_MESSAGES
  59 static void
  60 win32_error(u32 err_code)
  61 {
  62         wchar_t *buffer;
  63         DWORD nchars;
  64         nchars = FormatMessageW(FORMAT_MESSAGE_FROM_SYSTEM |
  65                                     FORMAT_MESSAGE_ALLOCATE_BUFFER,
  66                                 NULL, err_code, 0,
  67                                 (wchar_t*)&buffer, 0, NULL);
  68         if (nchars == 0) {
  69                 ERROR("Error printing error message! "
  70                       "Computer will self-destruct in 3 seconds.");
  71         } else {
  72                 ERROR("Win32 error: %ls", buffer);
  73                 LocalFree(buffer);
  74         }
  75 }
  76 #else /* ENABLE_ERROR_MESSAGES */
  77 #  define win32_error(err_code)
  78 #endif /* !ENABLE_ERROR_MESSAGES */
  79
  80 /* Pointers to functions that are not available on all targetted versions of
  81  * Windows (XP and later).  NOTE: The WINAPI annotations seem to be important; I
  82  * assume it specifies a certain calling convention. */
  83
  84 /* Vista and later */
  85 static HANDLE (WINAPI *win32func_FindFirstStreamW)(LPCWSTR lpFileName,
  86                                             STREAM_INFO_LEVELS InfoLevel,
  87                                             LPVOID lpFindStreamData,
  88                                             DWORD dwFlags) = NULL;
  89
  90 /* Vista and later */
  91 static BOOL (WINAPI *win32func_FindNextStreamW)(HANDLE hFindStream,
  92                                          LPVOID lpFindStreamData) = NULL;
  93
  94 static HMODULE hKernel32 = NULL;
  95
  96 /* Try to dynamically load some functions */
  97 void
  98 win32_global_init()
  99 {
 100         DWORD err;
 101
 102         if (hKernel32 == NULL) {
 103                 DEBUG("Loading Kernel32.dll");
 104                 hKernel32 = LoadLibraryW(L"Kernel32.dll");
 105                 if (hKernel32 == NULL) {
 106                         err = GetLastError();
 107                         WARNING("Can't load Kernel32.dll");
 108                         win32_error(err);
 109                         return;
 110                 }
 111         }
 112
 113         DEBUG("Looking for FindFirstStreamW");
 114         win32func_FindFirstStreamW = (void*)GetProcAddress(hKernel32, "FindFirstStreamW");
 115         if (!win32func_FindFirstStreamW) {
 116                 WARNING("Could not find function FindFirstStreamW() in Kernel32.dll!");
 117                 WARNING("Capturing alternate data streams will not be supported.");
 118                 return;
 119         }
 120
 121         DEBUG("Looking for FindNextStreamW");
 122         win32func_FindNextStreamW = (void*)GetProcAddress(hKernel32, "FindNextStreamW");
 123         if (!win32func_FindNextStreamW) {
 124                 WARNING("Could not find function FindNextStreamW() in Kernel32.dll!");
 125                 WARNING("Capturing alternate data streams will not be supported.");
 126                 win32func_FindFirstStreamW = NULL;
 127         }
 128 }
 129
 130 void
 131 win32_global_cleanup()
 132 {
 133         if (hKernel32 != NULL) {
 134                 DEBUG("Closing Kernel32.dll");
 135                 FreeLibrary(hKernel32);
 136                 hKernel32 = NULL;
 137         }
 138 }
 139
 140 static const wchar_t *capture_access_denied_msg =
 141 L"         If you are not running this program as the administrator, you may\n"
 142  "         need to do so, so that all data and metadata can be backed up.\n"
 143  "         Otherwise, there may be no way to access the desired data or\n"
 144  "         metadata without taking ownership of the file or directory.\n"
 145  ;
 146
 147 static const wchar_t *apply_access_denied_msg =
 148 L"If you are not running this program as the administrator, you may\n"
 149  "          need to do so, so that all data and metadata can be extracted\n"
 150  "          exactly as the origignal copy.  However, if you do not care that\n"
 151  "          the security descriptors are extracted correctly, you could run\n"
 152  "          `wimlib-imagex apply' with the --no-acls flag instead.\n"
 153  ;
 154
 155 static HANDLE
 156 win32_open_existing_file(const wchar_t *path, DWORD dwDesiredAccess)
 157 {
 158         return CreateFileW(path,
 159                            dwDesiredAccess,
 160                            FILE_SHARE_READ,
 161                            NULL, /* lpSecurityAttributes */
 162                            OPEN_EXISTING,
 163                            FILE_FLAG_BACKUP_SEMANTICS |
 164                                FILE_FLAG_OPEN_REPARSE_POINT,
 165                            NULL /* hTemplateFile */);
 166 }
 167
 168 HANDLE
 169 win32_open_file_data_only(const wchar_t *path)
 170 {
 171         return win32_open_existing_file(path, FILE_READ_DATA);
 172 }
 173
 174 int
 175 read_win32_file_prefix(const struct wim_lookup_table_entry *lte,
 176                        u64 size,
 177                        consume_data_callback_t cb,
 178                        void *ctx_or_buf,
 179                        int _ignored_flags)
 180 {
 181         int ret = 0;
 182         void *out_buf;
 183         DWORD err;
 184         u64 bytes_remaining;
 185
 186         HANDLE hFile = win32_open_file_data_only(lte->file_on_disk);
 187         if (hFile == INVALID_HANDLE_VALUE) {
 188                 err = GetLastError();
 189                 ERROR("Failed to open \"%ls\"", lte->file_on_disk);
 190                 win32_error(err);
 191                 return WIMLIB_ERR_OPEN;
 192         }
 193
 194         if (cb)
 195                 out_buf = alloca(WIM_CHUNK_SIZE);
 196         else
 197                 out_buf = ctx_or_buf;
 198
 199         bytes_remaining = size;
 200         while (bytes_remaining) {
 201                 DWORD bytesToRead, bytesRead;
 202
 203                 bytesToRead = min(WIM_CHUNK_SIZE, bytes_remaining);
 204                 if (!ReadFile(hFile, out_buf, bytesToRead, &bytesRead, NULL) ||
 205                     bytesRead != bytesToRead)
 206                 {
 207                         err = GetLastError();
 208                         ERROR("Failed to read data from \"%ls\"", lte->file_on_disk);
 209                         win32_error(err);
 210                         ret = WIMLIB_ERR_READ;
 211                         break;
 212                 }
 213                 bytes_remaining -= bytesRead;
 214                 if (cb) {
 215                         ret = (*cb)(out_buf, bytesRead, ctx_or_buf);
 216                         if (ret)
 217                                 break;
 218                 } else {
 219                         out_buf += bytesRead;
 220                 }
 221         }
 222         CloseHandle(hFile);
 223         return ret;
 224 }
 225
 226 struct win32_encrypted_read_ctx {
 227         consume_data_callback_t read_prefix_cb;
 228         void *read_prefix_ctx_or_buf;
 229         int wimlib_err_code;
 230         void *buf;
 231         size_t buf_filled;
 232         u64 bytes_remaining;
 233 };
 234
 235 static DWORD WINAPI
 236 win32_encrypted_export_cb(unsigned char *_data, void *_ctx, unsigned long len)
 237 {
 238         const void *data = _data;
 239         struct win32_encrypted_read_ctx *ctx = _ctx;
 240         int ret;
 241
 242         DEBUG("len = %lu", len);
 243         if (ctx->read_prefix_cb) {
 244                 /* The length of the buffer passed to the ReadEncryptedFileRaw()
 245                  * export callback is undocumented, so we assume it may be of
 246                  * arbitrary size. */
 247                 size_t bytes_to_buffer = min(ctx->bytes_remaining - ctx->buf_filled,
 248                                              len);
 249                 while (bytes_to_buffer) {
 250                         size_t bytes_to_copy_to_buf =
 251                                 min(bytes_to_buffer, WIM_CHUNK_SIZE - ctx->buf_filled);
 252
 253                         memcpy(ctx->buf + ctx->buf_filled, data,
 254                                bytes_to_copy_to_buf);
 255                         ctx->buf_filled += bytes_to_copy_to_buf;
 256                         data += bytes_to_copy_to_buf;
 257                         bytes_to_buffer -= bytes_to_copy_to_buf;
 258
 259                         if (ctx->buf_filled == WIM_CHUNK_SIZE ||
 260                             ctx->buf_filled == ctx->bytes_remaining)
 261                         {
 262                                 ret = (*ctx->read_prefix_cb)(ctx->buf,
 263                                                              ctx->buf_filled,
 264                                                              ctx->read_prefix_ctx_or_buf);
 265                                 if (ret) {
 266                                         ctx->wimlib_err_code = ret;
 267                                         /* Shouldn't matter what error code is returned
 268                                          * here, as long as it isn't ERROR_SUCCESS. */
 269                                         return ERROR_READ_FAULT;
 270                                 }
 271                                 ctx->bytes_remaining -= ctx->buf_filled;
 272                                 ctx->buf_filled = 0;
 273                         }
 274                 }
 275         } else {
 276                 size_t len_to_copy = min(len, ctx->bytes_remaining);
 277                 memcpy(ctx->read_prefix_ctx_or_buf, data, len_to_copy);
 278                 ctx->bytes_remaining -= len_to_copy;
 279                 ctx->read_prefix_ctx_or_buf += len_to_copy;
 280         }
 281         return ERROR_SUCCESS;
 282 }
 283
 284 int
 285 read_win32_encrypted_file_prefix(const struct wim_lookup_table_entry *lte,
 286                                  u64 size,
 287                                  consume_data_callback_t cb,
 288                                  void *ctx_or_buf,
 289                                  int _ignored_flags)
 290 {
 291         struct win32_encrypted_read_ctx export_ctx;
 292         DWORD err;
 293         void *file_ctx;
 294         int ret;
 295
 296         DEBUG("Reading %"PRIu64" bytes from encryted file \"%ls\"",
 297               size, lte->file_on_disk);
 298
 299         export_ctx.read_prefix_cb = cb;
 300         export_ctx.read_prefix_ctx_or_buf = ctx_or_buf;
 301         export_ctx.wimlib_err_code = 0;
 302         if (cb) {
 303                 export_ctx.buf = MALLOC(WIM_CHUNK_SIZE);
 304                 if (!export_ctx.buf)
 305                         return WIMLIB_ERR_NOMEM;
 306         } else {
 307                 export_ctx.buf = NULL;
 308         }
 309         export_ctx.bytes_remaining = size;
 310
 311         err = OpenEncryptedFileRawW(lte->file_on_disk, 0, &file_ctx);
 312         if (err != ERROR_SUCCESS) {
 313                 ERROR("Failed to open encrypted file \"%ls\" for raw read",
 314                       lte->file_on_disk);
 315                 win32_error(err);
 316                 ret = WIMLIB_ERR_OPEN;
 317                 goto out_free_buf;
 318         }
 319         err = ReadEncryptedFileRaw(win32_encrypted_export_cb,
 320                                    &export_ctx, file_ctx);
 321         if (err != ERROR_SUCCESS) {
 322                 ERROR("Failed to read encrypted file \"%ls\"",
 323                       lte->file_on_disk);
 324                 win32_error(err);
 325                 ret = export_ctx.wimlib_err_code;
 326                 if (ret == 0)
 327                         ret = WIMLIB_ERR_READ;
 328         } else if (export_ctx.bytes_remaining != 0) {
 329                 ERROR("Only could read %"PRIu64" of %"PRIu64" bytes from "
 330                       "encryted file \"%ls\"",
 331                       size - export_ctx.bytes_remaining, size,
 332                       lte->file_on_disk);
 333                 ret = WIMLIB_ERR_READ;
 334         } else {
 335                 ret = 0;
 336         }
 337         CloseEncryptedFileRaw(file_ctx);
 338 out_free_buf:
 339         FREE(export_ctx.buf);
 340         return ret;
 341 }
 342
 343 /* Given a path, which may not yet exist, get a set of flags that describe the
 344  * features of the volume the path is on. */
 345 static int
 346 win32_get_vol_flags(const wchar_t *path, unsigned *vol_flags_ret)
 347 {
 348         wchar_t *volume;
 349         BOOL bret;
 350         DWORD vol_flags;
 351
 352         if (path[0] != L'\0' && path[0] != L'\\' &&
 353             path[0] != L'/' && path[1] == L':')
 354         {
 355                 /* Path starts with a drive letter; use it. */
 356                 volume = alloca(4 * sizeof(wchar_t));
 357                 volume[0] = path[0];
 358                 volume[1] = path[1];
 359                 volume[2] = L'\\';
 360                 volume[3] = L'\0';
 361         } else {
 362                 /* Path does not start with a drive letter; use the volume of
 363                  * the current working directory. */
 364                 volume = NULL;
 365         }
 366         bret = GetVolumeInformationW(volume, /* lpRootPathName */
 367                                      NULL,  /* lpVolumeNameBuffer */
 368                                      0,     /* nVolumeNameSize */
 369                                      NULL,  /* lpVolumeSerialNumber */
 370                                      NULL,  /* lpMaximumComponentLength */
 371                                      &vol_flags, /* lpFileSystemFlags */
 372                                      NULL,  /* lpFileSystemNameBuffer */
 373                                      0);    /* nFileSystemNameSize */
 374         if (!bret) {
 375                 DWORD err = GetLastError();
 376                 WARNING("Failed to get volume information for path \"%ls\"", path);
 377                 win32_error(err);
 378                 vol_flags = 0xffffffff;
 379         }
 380
 381         DEBUG("using vol_flags = %x", vol_flags);
 382         *vol_flags_ret = vol_flags;
 383         return 0;
 384 }
 385
 386
 387 static u64
 388 FILETIME_to_u64(const FILETIME *ft)
 389 {
 390         return ((u64)ft->dwHighDateTime << 32) | (u64)ft->dwLowDateTime;
 391 }
 392
 393 static int
 394 win32_get_short_name(struct wim_dentry *dentry, const wchar_t *path)
 395 {
 396         WIN32_FIND_DATAW dat;
 397         if (FindFirstFileW(path, &dat) && dat.cAlternateFileName[0] != L'\0') {
 398                 DEBUG("\"%ls\": short name \"%ls\"", path, dat.cAlternateFileName);
 399                 size_t short_name_nbytes = wcslen(dat.cAlternateFileName) *
 400                                            sizeof(wchar_t);
 401                 size_t n = short_name_nbytes + sizeof(wchar_t);
 402                 dentry->short_name = MALLOC(n);
 403                 if (!dentry->short_name)
 404                         return WIMLIB_ERR_NOMEM;
 405                 memcpy(dentry->short_name, dat.cAlternateFileName, n);
 406                 dentry->short_name_nbytes = short_name_nbytes;
 407         }
 408         /* If we can't read the short filename for some reason, we just ignore
 409          * the error and assume the file has no short name.  I don't think this
 410          * should be an issue, since the short names are essentially obsolete
 411          * anyway. */
 412         return 0;
 413 }
 414
 415 static int
 416 win32_get_security_descriptor(struct wim_dentry *dentry,
 417                               struct sd_set *sd_set,
 418                               const wchar_t *path,
 419                               struct win32_capture_state *state,
 420                               int add_image_flags)
 421 {
 422         SECURITY_INFORMATION requestedInformation;
 423         DWORD lenNeeded = 0;
 424         BOOL status;
 425         DWORD err;
 426         unsigned long n;
 427
 428         requestedInformation = DACL_SECURITY_INFORMATION |
 429                                SACL_SECURITY_INFORMATION |
 430                                OWNER_SECURITY_INFORMATION |
 431                                GROUP_SECURITY_INFORMATION;
 432 again:
 433         /* Request length of security descriptor */
 434         status = GetFileSecurityW(path, requestedInformation,
 435                                   NULL, 0, &lenNeeded);
 436         err = GetLastError();
 437         if (!status && err == ERROR_INSUFFICIENT_BUFFER) {
 438                 DWORD len = lenNeeded;
 439                 char buf[len];
 440                 if (GetFileSecurityW(path, requestedInformation,
 441                                      (PSECURITY_DESCRIPTOR)buf, len, &lenNeeded))
 442                 {
 443                         int security_id = sd_set_add_sd(sd_set, buf, len);
 444                         if (security_id < 0)
 445                                 return WIMLIB_ERR_NOMEM;
 446                         else {
 447                                 dentry->d_inode->i_security_id = security_id;
 448                                 return 0;
 449                         }
 450                 } else {
 451                         err = GetLastError();
 452                 }
 453         }
 454
 455         if (add_image_flags & WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS)
 456                 goto fail;
 457
 458         switch (err) {
 459         case ERROR_PRIVILEGE_NOT_HELD:
 460                 if (requestedInformation & SACL_SECURITY_INFORMATION) {
 461                         n = state->num_get_sacl_priv_notheld++;
 462                         requestedInformation &= ~SACL_SECURITY_INFORMATION;
 463                         if (n < MAX_GET_SACL_PRIV_NOTHELD_WARNINGS) {
 464                                 WARNING(
 465 "We don't have enough privileges to read the full security\n"
 466 "          descriptor of \"%ls\"!\n"
 467 "          Re-trying with SACL omitted.\n", path);
 468                         } else if (n == MAX_GET_SACL_PRIV_NOTHELD_WARNINGS) {
 469                                 WARNING(
 470 "Suppressing further privileges not held error messages when reading\n"
 471 "          security descriptors.");
 472                         }
 473                         goto again;
 474                 }
 475                 /* Fall through */
 476         case ERROR_ACCESS_DENIED:
 477                 n = state->num_get_sd_access_denied++;
 478                 if (n < MAX_GET_SD_ACCESS_DENIED_WARNINGS) {
 479                         WARNING("Failed to read security descriptor of \"%ls\": "
 480                                 "Access denied!\n%ls", path, capture_access_denied_msg);
 481                 } else if (n == MAX_GET_SD_ACCESS_DENIED_WARNINGS) {
 482                         WARNING("Suppressing further access denied errors messages i"
 483                                 "when reading security descriptors");
 484                 }
 485                 return 0;
 486         default:
 487 fail:
 488                 ERROR("Failed to read security descriptor of \"%ls\"", path);
 489                 win32_error(err);
 490                 return WIMLIB_ERR_READ;
 491         }
 492 }
 493
 494 static int
 495 win32_build_dentry_tree_recursive(struct wim_dentry **root_ret,
 496                                   wchar_t *path,
 497                                   size_t path_num_chars,
 498                                   struct add_image_params *params,
 499                                   struct win32_capture_state *state,
 500                                   unsigned vol_flags);
 501
 502 /* Reads the directory entries of directory using a Win32 API and recursively
 503  * calls win32_build_dentry_tree() on them. */
 504 static int
 505 win32_recurse_directory(struct wim_dentry *root,
 506                         wchar_t *dir_path,
 507                         size_t dir_path_num_chars,
 508                         struct add_image_params *params,
 509                         struct win32_capture_state *state,
 510                         unsigned vol_flags)
 511 {
 512         WIN32_FIND_DATAW dat;
 513         HANDLE hFind;
 514         DWORD err;
 515         int ret;
 516
 517         DEBUG("Recurse to directory \"%ls\"", dir_path);
 518
 519         /* Begin reading the directory by calling FindFirstFileW.  Unlike UNIX
 520          * opendir(), FindFirstFileW has file globbing built into it.  But this
 521          * isn't what we actually want, so just add a dummy glob to get all
 522          * entries. */
 523         dir_path[dir_path_num_chars] = L'/';
 524         dir_path[dir_path_num_chars + 1] = L'*';
 525         dir_path[dir_path_num_chars + 2] = L'\0';
 526         hFind = FindFirstFileW(dir_path, &dat);
 527         dir_path[dir_path_num_chars] = L'\0';
 528
 529         if (hFind == INVALID_HANDLE_VALUE) {
 530                 err = GetLastError();
 531                 if (err == ERROR_FILE_NOT_FOUND) {
 532                         return 0;
 533                 } else {
 534                         ERROR("Failed to read directory \"%ls\"", dir_path);
 535                         win32_error(err);
 536                         return WIMLIB_ERR_READ;
 537                 }
 538         }
 539         ret = 0;
 540         do {
 541                 /* Skip . and .. entries */
 542                 if (dat.cFileName[0] == L'.' &&
 543                     (dat.cFileName[1] == L'\0' ||
 544                      (dat.cFileName[1] == L'.' &&
 545                       dat.cFileName[2] == L'\0')))
 546                         continue;
 547                 size_t filename_len = wcslen(dat.cFileName);
 548
 549                 dir_path[dir_path_num_chars] = L'/';
 550                 wmemcpy(dir_path + dir_path_num_chars + 1,
 551                         dat.cFileName,
 552                         filename_len + 1);
 553
 554                 struct wim_dentry *child;
 555                 size_t path_len = dir_path_num_chars + 1 + filename_len;
 556                 ret = win32_build_dentry_tree_recursive(&child,
 557                                                         dir_path,
 558                                                         path_len,
 559                                                         params,
 560                                                         state,
 561                                                         vol_flags);
 562                 dir_path[dir_path_num_chars] = L'\0';
 563                 if (ret)
 564                         goto out_find_close;
 565                 if (child)
 566                         dentry_add_child(root, child);
 567         } while (FindNextFileW(hFind, &dat));
 568         err = GetLastError();
 569         if (err != ERROR_NO_MORE_FILES) {
 570                 ERROR("Failed to read directory \"%ls\"", dir_path);
 571                 win32_error(err);
 572                 if (ret == 0)
 573                         ret = WIMLIB_ERR_READ;
 574         }
 575 out_find_close:
 576         FindClose(hFind);
 577         return ret;
 578 }
 579
 580 int
 581 win32_get_file_and_vol_ids(const wchar_t *path, u64 *ino_ret, u64 *dev_ret)
 582 {
 583         HANDLE hFile;
 584         DWORD err;
 585         BY_HANDLE_FILE_INFORMATION file_info;
 586         int ret;
 587
 588         hFile = win32_open_existing_file(path, FILE_READ_ATTRIBUTES);
 589         if (hFile == INVALID_HANDLE_VALUE) {
 590                 err = GetLastError();
 591                 WARNING("Failed to open \"%ls\" to get file and volume IDs",
 592                         path);
 593                 win32_error(err);
 594                 return WIMLIB_ERR_OPEN;
 595         }
 596
 597         if (!GetFileInformationByHandle(hFile, &file_info)) {
 598                 err = GetLastError();
 599                 ERROR("Failed to get file information for \"%ls\"", path);
 600                 win32_error(err);
 601                 ret = WIMLIB_ERR_STAT;
 602         } else {
 603                 *ino_ret = ((u64)file_info.nFileIndexHigh << 32) |
 604                             (u64)file_info.nFileIndexLow;
 605                 *dev_ret = file_info.dwVolumeSerialNumber;
 606                 ret = 0;
 607         }
 608         CloseHandle(hFile);
 609         return ret;
 610 }
 611
 612 enum rp_status {
 613         RP_EXCLUDED       = 0x0,
 614         RP_NOT_FIXED      = 0x1,
 615         RP_FIXED_FULLPATH = 0x2,
 616         RP_FIXED_ABSPATH  = 0x4,
 617         RP_FIXED          = RP_FIXED_FULLPATH | RP_FIXED_ABSPATH,
 618 };
 619
 620 static enum rp_status
 621 win32_maybe_rpfix_target(wchar_t *target, size_t *target_nchars_p,
 622                          u64 capture_root_ino, u64 capture_root_dev)
 623 {
 624         size_t target_nchars= *target_nchars_p;
 625         size_t stripped_chars;
 626         wchar_t *orig_target;
 627
 628         if (target_nchars == 0)
 629                 return RP_NOT_FIXED;
 630
 631         if (target[0] == L'\\') {
 632                 if (target_nchars >= 2 && target[1] == L'\\') {
 633                         /* Probaby a volume.  Can't do anything with it. */
 634                         DEBUG("Not fixing target (probably a volume)");
 635                         return RP_NOT_FIXED;
 636                 } else if (target_nchars >= 7 &&
 637                            target[1] == '?' &&
 638                            target[2] == '?' &&
 639                            target[3] == '\\' &&
 640                            target[4] != '\0' &&
 641                            target[5] == ':' &&
 642                            target[6] == '\\')
 643                 {
 644                         DEBUG("Full style path");
 645                         /* Full \??\x:\ style path (may be junction or symlink)
 646                          * */
 647                         stripped_chars = 4;
 648                 } else {
 649                         DEBUG("Absolute target without drive letter");
 650                         /* Absolute target, without drive letter */
 651                         stripped_chars = 0;
 652                 }
 653         } else if (target_nchars >= 3 &&
 654                    target[0] != L'\0' &&
 655                    target[1] == L':' &&
 656                    target[2] == L'\\')
 657         {
 658                 DEBUG("Absolute target with drive letter");
 659                 /* Absolute target, with drive letter */
 660                 stripped_chars = 0;
 661         } else {
 662                 DEBUG("Relative symlink or other link");
 663                 /* Relative symlink or other unexpected format */
 664                 return RP_NOT_FIXED;
 665         }
 666         target[target_nchars] = L'\0';
 667         orig_target = target;
 668         target = fixup_symlink(target + stripped_chars, capture_root_ino, capture_root_dev);
 669         if (target) {
 670                 target_nchars = wcslen(target);
 671                 wmemmove(orig_target + stripped_chars, target, target_nchars + 1);
 672                 *target_nchars_p = target_nchars + stripped_chars;
 673                 DEBUG("Fixed reparse point (new target: \"%ls\")", orig_target);
 674                 return stripped_chars ? RP_FIXED_FULLPATH : RP_FIXED_ABSPATH;
 675         } else {
 676                 return RP_EXCLUDED;
 677         }
 678 }
 679
 680 static enum rp_status
 681 win32_do_capture_rpfix(char *rpbuf, DWORD *rpbuflen_p,
 682                        u64 capture_root_ino, u64 capture_root_dev)
 683 {
 684         const char *p_get;
 685         char *p_put;
 686         u16 substitute_name_offset;
 687         u16 substitute_name_len;
 688         wchar_t *target;
 689         size_t target_nchars;
 690         enum rp_status status;
 691         u32 rptag;
 692         DWORD rpbuflen = *rpbuflen_p;
 693
 694         if (rpbuflen < 16)
 695                 return RP_EXCLUDED;
 696         p_get = get_u32(rpbuf, &rptag);
 697         p_get += 4;
 698         p_get = get_u16(p_get, &substitute_name_offset);
 699         p_get = get_u16(p_get, &substitute_name_len);
 700         p_get += 4;
 701         if ((size_t)substitute_name_offset + substitute_name_len > rpbuflen)
 702                 return RP_EXCLUDED;
 703         if (rptag == WIM_IO_REPARSE_TAG_SYMLINK) {
 704                 if (rpbuflen < 20)
 705                         return RP_EXCLUDED;
 706                 p_get += 4;
 707         }
 708
 709
 710         target = (wchar_t*)&p_get[substitute_name_offset];
 711         target_nchars = substitute_name_len / 2;
 712         /* Note: target is not necessarily null-terminated */
 713
 714         status = win32_maybe_rpfix_target(target, &target_nchars,
 715                                           capture_root_ino, capture_root_dev);
 716         if (status & RP_FIXED) {
 717                 size_t target_nbytes = target_nchars * 2;
 718                 size_t print_nbytes = target_nbytes;
 719                 wchar_t target_copy[target_nchars];
 720                 wchar_t *print_name = target_copy;
 721
 722                 if (status == RP_FIXED_FULLPATH) {
 723                         print_nbytes -= 8;
 724                         print_name += 4;
 725                 }
 726                 wmemcpy(target_copy, target, target_nchars);
 727                 p_put = rpbuf + 8;
 728                 p_put = put_u16(p_put, 0); /* Substitute name offset */
 729                 p_put = put_u16(p_put, target_nbytes); /* Substitute name length */
 730                 p_put = put_u16(p_put, target_nbytes + 2); /* Print name offset */
 731                 p_put = put_u16(p_put, print_nbytes); /* Print name length */
 732                 if (rptag == WIM_IO_REPARSE_TAG_SYMLINK)
 733                         p_put = put_u32(p_put, 1);
 734                 p_put = put_bytes(p_put, target_nbytes, target_copy);
 735                 p_put = put_u16(p_put, 0);
 736                 p_put = put_bytes(p_put, print_nbytes, print_name);
 737                 p_put = put_u16(p_put, 0);
 738                 rpbuflen = p_put - rpbuf;
 739                 put_u16(rpbuf + 4, rpbuflen - 8);
 740                 *rpbuflen_p = rpbuflen;
 741         }
 742         return status;
 743 }
 744
 745 /* Load a reparse point into a WIM inode.  It is just stored in memory.
 746  *
 747  * @hFile is the open handle to a reparse point, with permission to read the
 748  * reparse data.
 749  *
 750  * @inode is the WIM inode for the reparse point.
 751  */
 752 static int
 753 win32_capture_reparse_point(struct wim_dentry **root_p,
 754                             HANDLE hFile,
 755                             struct wim_inode *inode,
 756                             const wchar_t *path,
 757                             struct add_image_params *params)
 758 {
 759         DEBUG("Capturing reparse point \"%ls\"", path);
 760
 761         /* "Reparse point data, including the tag and optional GUID,
 762          * cannot exceed 16 kilobytes." - MSDN  */
 763         char reparse_point_buf[REPARSE_POINT_MAX_SIZE];
 764         DWORD bytesReturned;
 765         char *fixed_buf;
 766         DWORD fixed_len;
 767
 768         if (!DeviceIoControl(hFile, FSCTL_GET_REPARSE_POINT,
 769                              NULL, /* "Not used with this operation; set to NULL" */
 770                              0, /* "Not used with this operation; set to 0" */
 771                              reparse_point_buf, /* "A pointer to a buffer that
 772                                                    receives the reparse point data */
 773                              sizeof(reparse_point_buf), /* "The size of the output
 774                                                            buffer, in bytes */
 775                              &bytesReturned,
 776                              NULL))
 777         {
 778                 DWORD err = GetLastError();
 779                 ERROR("Failed to get reparse data of \"%ls\"", path);
 780                 win32_error(err);
 781                 return WIMLIB_ERR_READ;
 782         }
 783         if (bytesReturned < 8) {
 784                 ERROR("Reparse data on \"%ls\" is invalid", path);
 785                 return WIMLIB_ERR_READ;
 786         }
 787         inode->i_reparse_tag = le32_to_cpu(*(u32*)reparse_point_buf);
 788
 789         if (params->add_image_flags & WIMLIB_ADD_IMAGE_FLAG_RPFIX &&
 790             (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
 791              inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT))
 792         {
 793                 enum rp_status status;
 794                 status = win32_do_capture_rpfix(reparse_point_buf,
 795                                                 &bytesReturned,
 796                                                 params->capture_root_ino,
 797                                                 params->capture_root_dev);
 798                 if (status == RP_EXCLUDED) {
 799                         free_dentry(*root_p);
 800                         *root_p = NULL;
 801                         return 0;
 802                 } else if (status & RP_FIXED) {
 803                         inode->i_not_rpfixed = 0;
 804                 }
 805         }
 806         return inode_set_unnamed_stream(inode, reparse_point_buf + 8,
 807                                         bytesReturned - 8, params->lookup_table);
 808 }
 809
 810 /* Scans an unnamed or named stream of a Win32 file (not a reparse point
 811  * stream); calculates its SHA1 message digest and either creates a `struct
 812  * wim_lookup_table_entry' in memory for it, or uses an existing 'struct
 813  * wim_lookup_table_entry' for an identical stream.
 814  *
 815  * @path:               Path to the file (UTF-16LE).
 816  *
 817  * @path_num_chars:     Number of 2-byte characters in @path.
 818  *
 819  * @inode:              WIM inode to save the stream into.
 820  *
 821  * @lookup_table:       Stream lookup table for the WIM.
 822  *
 823  * @dat:                A `WIN32_FIND_STREAM_DATA' structure that specifies the
 824  *                      stream name.
 825  *
 826  * Returns 0 on success; nonzero on failure.
 827  */
 828 static int
 829 win32_capture_stream(const wchar_t *path,
 830                      size_t path_num_chars,
 831                      struct wim_inode *inode,
 832                      struct wim_lookup_table *lookup_table,
 833                      WIN32_FIND_STREAM_DATA *dat)
 834 {
 835         struct wim_ads_entry *ads_entry;
 836         struct wim_lookup_table_entry *lte;
 837         int ret;
 838         wchar_t *stream_name, *colon;
 839         size_t stream_name_nchars;
 840         bool is_named_stream;
 841         wchar_t *spath;
 842         size_t spath_nchars;
 843         size_t spath_buf_nbytes;
 844         const wchar_t *relpath_prefix;
 845         const wchar_t *colonchar;
 846
 847         DEBUG("Capture \"%ls\" stream \"%ls\"", path, dat->cStreamName);
 848
 849         /* The stream name should be returned as :NAME:TYPE */
 850         stream_name = dat->cStreamName;
 851         if (*stream_name != L':')
 852                 goto out_invalid_stream_name;
 853         stream_name += 1;
 854         colon = wcschr(stream_name, L':');
 855         if (colon == NULL)
 856                 goto out_invalid_stream_name;
 857
 858         if (wcscmp(colon + 1, L"$DATA")) {
 859                 /* Not a DATA stream */
 860                 ret = 0;
 861                 goto out;
 862         }
 863
 864         *colon = '\0';
 865
 866         stream_name_nchars = colon - stream_name;
 867         is_named_stream = (stream_name_nchars != 0);
 868
 869         if (is_named_stream) {
 870                 /* Allocate an ADS entry for the named stream. */
 871                 ads_entry = inode_add_ads_utf16le(inode, stream_name,
 872                                                   stream_name_nchars * sizeof(wchar_t));
 873                 if (!ads_entry) {
 874                         ret = WIMLIB_ERR_NOMEM;
 875                         goto out;
 876                 }
 877         }
 878
 879         /* If zero length stream, no lookup table entry needed. */
 880         if ((u64)dat->StreamSize.QuadPart == 0) {
 881                 ret = 0;
 882                 goto out;
 883         }
 884
 885         /* Create a UTF-16LE string @spath that gives the filename, then a
 886          * colon, then the stream name.  Or, if it's an unnamed stream, just the
 887          * filename.  It is MALLOC()'ed so that it can be saved in the
 888          * wim_lookup_table_entry if needed.
 889          *
 890          * As yet another special case, relative paths need to be changed to
 891          * begin with an explicit "./" so that, for example, a file t:ads, where
 892          * :ads is the part we added, is not interpreted as a file on the t:
 893          * drive. */
 894         spath_nchars = path_num_chars;
 895         relpath_prefix = L"";
 896         colonchar = L"";
 897         if (is_named_stream) {
 898                 spath_nchars += 1 + stream_name_nchars;
 899                 colonchar = L":";
 900                 if (path_num_chars == 1 &&
 901                     path[0] != L'/' &&
 902                     path[0] != L'\\')
 903                 {
 904                         spath_nchars += 2;
 905                         relpath_prefix = L"./";
 906                 }
 907         }
 908
 909         spath_buf_nbytes = (spath_nchars + 1) * sizeof(wchar_t);
 910         spath = MALLOC(spath_buf_nbytes);
 911
 912         swprintf(spath, L"%ls%ls%ls%ls",
 913                  relpath_prefix, path, colonchar, stream_name);
 914
 915         /* Make a new wim_lookup_table_entry */
 916         lte = new_lookup_table_entry();
 917         if (!lte) {
 918                 ret = WIMLIB_ERR_NOMEM;
 919                 goto out_free_spath;
 920         }
 921         lte->file_on_disk = spath;
 922         spath = NULL;
 923         if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED && !is_named_stream)
 924                 lte->resource_location = RESOURCE_WIN32_ENCRYPTED;
 925         else
 926                 lte->resource_location = RESOURCE_WIN32;
 927         lte->resource_entry.original_size = (u64)dat->StreamSize.QuadPart;
 928
 929         u32 stream_id;
 930         if (is_named_stream) {
 931                 stream_id = ads_entry->stream_id;
 932                 ads_entry->lte = lte;
 933         } else {
 934                 stream_id = 0;
 935                 inode->i_lte = lte;
 936         }
 937         lookup_table_insert_unhashed(lookup_table, lte, inode, stream_id);
 938         ret = 0;
 939 out_free_spath:
 940         FREE(spath);
 941 out:
 942         return ret;
 943 out_invalid_stream_name:
 944         ERROR("Invalid stream name: \"%ls:%ls\"", path, dat->cStreamName);
 945         ret = WIMLIB_ERR_READ;
 946         goto out;
 947 }
 948
 949 /* Scans a Win32 file for unnamed and named data streams (not reparse point
 950  * streams).
 951  *
 952  * @path:               Path to the file (UTF-16LE).
 953  *
 954  * @path_num_chars:     Number of 2-byte characters in @path.
 955  *
 956  * @inode:              WIM inode to save the stream into.
 957  *
 958  * @lookup_table:       Stream lookup table for the WIM.
 959  *
 960  * @file_size:          Size of unnamed data stream.  (Used only if alternate
 961  *                      data streams API appears to be unavailable.)
 962  *
 963  * @vol_flags:          Flags that specify features of the volume being
 964  *                      captured.
 965  *
 966  * Returns 0 on success; nonzero on failure.
 967  */
 968 static int
 969 win32_capture_streams(const wchar_t *path,
 970                       size_t path_num_chars,
 971                       struct wim_inode *inode,
 972                       struct wim_lookup_table *lookup_table,
 973                       u64 file_size,
 974                       unsigned vol_flags)
 975 {
 976         WIN32_FIND_STREAM_DATA dat;
 977         int ret;
 978         HANDLE hFind;
 979         DWORD err;
 980
 981         DEBUG("Capturing streams from \"%ls\"", path);
 982
 983         if (win32func_FindFirstStreamW == NULL ||
 984             !(vol_flags & FILE_NAMED_STREAMS))
 985                 goto unnamed_only;
 986
 987         hFind = win32func_FindFirstStreamW(path, FindStreamInfoStandard, &dat, 0);
 988         if (hFind == INVALID_HANDLE_VALUE) {
 989                 err = GetLastError();
 990                 if (err == ERROR_CALL_NOT_IMPLEMENTED)
 991                         goto unnamed_only;
 992
 993                 /* Seems legal for this to return ERROR_HANDLE_EOF on reparse
 994                  * points and directories */
 995                 if ((inode->i_attributes &
 996                     (FILE_ATTRIBUTE_REPARSE_POINT | FILE_ATTRIBUTE_DIRECTORY))
 997                     && err == ERROR_HANDLE_EOF)
 998                 {
 999                         DEBUG("ERROR_HANDLE_EOF (ok)");
1000                         return 0;
1001                 } else {
1002                         if (err == ERROR_ACCESS_DENIED) {
1003                                 ERROR("Failed to look up data streams "
1004                                       "of \"%ls\": Access denied!\n%ls",
1005                                       path, capture_access_denied_msg);
1006                                 return WIMLIB_ERR_READ;
1007                         } else {
1008                                 ERROR("Failed to look up data streams "
1009                                       "of \"%ls\"", path);
1010                                 win32_error(err);
1011                                 return WIMLIB_ERR_READ;
1012                         }
1013                 }
1014         }
1015         do {
1016                 ret = win32_capture_stream(path,
1017                                            path_num_chars,
1018                                            inode, lookup_table,
1019                                            &dat);
1020                 if (ret)
1021                         goto out_find_close;
1022         } while (win32func_FindNextStreamW(hFind, &dat));
1023         err = GetLastError();
1024         if (err != ERROR_HANDLE_EOF) {
1025                 ERROR("Win32 API: Error reading data streams from \"%ls\"", path);
1026                 win32_error(err);
1027                 ret = WIMLIB_ERR_READ;
1028         }
1029 out_find_close:
1030         FindClose(hFind);
1031         return ret;
1032 unnamed_only:
1033         /* FindFirstStreamW() API is not available, or the volume does not
1034          * support named streams.  Only capture the unnamed data stream. */
1035         DEBUG("Only capturing unnamed data stream");
1036         if (inode->i_attributes &
1037              (FILE_ATTRIBUTE_REPARSE_POINT | FILE_ATTRIBUTE_DIRECTORY))
1038         {
1039                 ret = 0;
1040         } else {
1041                 /* Just create our own WIN32_FIND_STREAM_DATA for an unnamed
1042                  * stream to reduce the code to a call to the
1043                  * already-implemented win32_capture_stream() */
1044                 wcscpy(dat.cStreamName, L"::$DATA");
1045                 dat.StreamSize.QuadPart = file_size;
1046                 ret = win32_capture_stream(path,
1047                                            path_num_chars,
1048                                            inode, lookup_table,
1049                                            &dat);
1050         }
1051         return ret;
1052 }
1053
1054 static int
1055 win32_build_dentry_tree_recursive(struct wim_dentry **root_ret,
1056                                   wchar_t *path,
1057                                   size_t path_num_chars,
1058                                   struct add_image_params *params,
1059                                   struct win32_capture_state *state,
1060                                   unsigned vol_flags)
1061 {
1062         struct wim_dentry *root = NULL;
1063         struct wim_inode *inode;
1064         DWORD err;
1065         u64 file_size;
1066         int ret = 0;
1067
1068         if (exclude_path(path, path_num_chars, params->config, true)) {
1069                 if (params->add_image_flags & WIMLIB_ADD_IMAGE_FLAG_ROOT) {
1070                         ERROR("Cannot exclude the root directory from capture");
1071                         ret = WIMLIB_ERR_INVALID_CAPTURE_CONFIG;
1072                         goto out;
1073                 }
1074                 if ((params->add_image_flags & WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE)
1075                     && params->progress_func)
1076                 {
1077                         union wimlib_progress_info info;
1078                         info.scan.cur_path = path;
1079                         info.scan.excluded = true;
1080                         params->progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info);
1081                 }
1082                 goto out;
1083         }
1084
1085         if ((params->add_image_flags & WIMLIB_ADD_IMAGE_FLAG_VERBOSE)
1086             && params->progress_func)
1087         {
1088                 union wimlib_progress_info info;
1089                 info.scan.cur_path = path;
1090                 info.scan.excluded = false;
1091                 params->progress_func(WIMLIB_PROGRESS_MSG_SCAN_DENTRY, &info);
1092         }
1093
1094         HANDLE hFile = win32_open_existing_file(path,
1095                                                 FILE_READ_DATA | FILE_READ_ATTRIBUTES);
1096         if (hFile == INVALID_HANDLE_VALUE) {
1097                 err = GetLastError();
1098                 ERROR("Win32 API: Failed to open \"%ls\"", path);
1099                 win32_error(err);
1100                 ret = WIMLIB_ERR_OPEN;
1101                 goto out;
1102         }
1103
1104         BY_HANDLE_FILE_INFORMATION file_info;
1105         if (!GetFileInformationByHandle(hFile, &file_info)) {
1106                 err = GetLastError();
1107                 ERROR("Win32 API: Failed to get file information for \"%ls\"",
1108                       path);
1109                 win32_error(err);
1110                 ret = WIMLIB_ERR_STAT;
1111                 goto out_close_handle;
1112         }
1113
1114         /* Create a WIM dentry with an associated inode, which may be shared */
1115         ret = inode_table_new_dentry(params->inode_table,
1116                                      path_basename_with_len(path, path_num_chars),
1117                                      ((u64)file_info.nFileIndexHigh << 32) |
1118                                          (u64)file_info.nFileIndexLow,
1119                                      file_info.dwVolumeSerialNumber,
1120                                      &root);
1121         if (ret)
1122                 goto out_close_handle;
1123
1124         ret = win32_get_short_name(root, path);
1125         if (ret)
1126                 goto out_close_handle;
1127
1128         inode = root->d_inode;
1129
1130         if (inode->i_nlink > 1) /* Shared inode; nothing more to do */
1131                 goto out_close_handle;
1132
1133         inode->i_attributes = file_info.dwFileAttributes;
1134         inode->i_creation_time = FILETIME_to_u64(&file_info.ftCreationTime);
1135         inode->i_last_write_time = FILETIME_to_u64(&file_info.ftLastWriteTime);
1136         inode->i_last_access_time = FILETIME_to_u64(&file_info.ftLastAccessTime);
1137         inode->i_resolved = 1;
1138
1139         params->add_image_flags &= ~(WIMLIB_ADD_IMAGE_FLAG_ROOT | WIMLIB_ADD_IMAGE_FLAG_SOURCE);
1140
1141         if (!(params->add_image_flags & WIMLIB_ADD_IMAGE_FLAG_NO_ACLS)
1142             && (vol_flags & FILE_PERSISTENT_ACLS))
1143         {
1144                 ret = win32_get_security_descriptor(root, params->sd_set,
1145                                                     path, state,
1146                                                     params->add_image_flags);
1147                 if (ret)
1148                         goto out_close_handle;
1149         }
1150
1151         file_size = ((u64)file_info.nFileSizeHigh << 32) |
1152                      (u64)file_info.nFileSizeLow;
1153
1154         if (inode_is_directory(inode)) {
1155                 /* Directory (not a reparse point) --- recurse to children */
1156
1157                 /* But first... directories may have alternate data streams that
1158                  * need to be captured. */
1159                 ret = win32_capture_streams(path,
1160                                             path_num_chars,
1161                                             inode,
1162                                             params->lookup_table,
1163                                             file_size,
1164                                             vol_flags);
1165                 if (ret)
1166                         goto out_close_handle;
1167                 ret = win32_recurse_directory(root,
1168                                               path,
1169                                               path_num_chars,
1170                                               params,
1171                                               state,
1172                                               vol_flags);
1173         } else if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
1174                 /* Reparse point: save the reparse tag and data.  Alternate data
1175                  * streams are not captured, if it's even possible for a reparse
1176                  * point to have alternate data streams... */
1177                 ret = win32_capture_reparse_point(&root, hFile, inode, path, params);
1178         } else {
1179                 /* Not a directory, not a reparse point; capture the default
1180                  * file contents and any alternate data streams. */
1181                 ret = win32_capture_streams(path,
1182                                             path_num_chars,
1183                                             inode,
1184                                             params->lookup_table,
1185                                             file_size,
1186                                             vol_flags);
1187         }
1188 out_close_handle:
1189         CloseHandle(hFile);
1190 out:
1191         if (ret == 0)
1192                 *root_ret = root;
1193         else
1194                 free_dentry_tree(root, params->lookup_table);
1195         return ret;
1196 }
1197
1198 static void
1199 win32_do_capture_warnings(const struct win32_capture_state *state,
1200                           int add_image_flags)
1201 {
1202         if (state->num_get_sacl_priv_notheld == 0 &&
1203             state->num_get_sd_access_denied == 0)
1204                 return;
1205
1206         WARNING("");
1207         WARNING("Built dentry tree successfully, but with the following problem(s):");
1208         if (state->num_get_sacl_priv_notheld != 0) {
1209                 WARNING("Could not capture SACL (System Access Control List)\n"
1210                         "          on %lu files or directories.",
1211                         state->num_get_sacl_priv_notheld);
1212         }
1213         if (state->num_get_sd_access_denied != 0) {
1214                 WARNING("Could not capture security descriptor at all\n"
1215                         "          on %lu files or directories.",
1216                         state->num_get_sd_access_denied);
1217         }
1218         WARNING(
1219           "Try running the program as the Administrator to make sure all the\n"
1220 "          desired metadata has been captured exactly.  However, if you\n"
1221 "          do not care about capturing security descriptors correctly, then\n"
1222 "          nothing more needs to be done%ls\n",
1223         (add_image_flags & WIMLIB_ADD_IMAGE_FLAG_NO_ACLS) ? L"." :
1224          L", although you might consider\n"
1225 "          passing the --no-acls flag to `wimlib-imagex capture' or\n"
1226 "          `wimlib-imagex append' to explicitly capture no security\n"
1227 "          descriptors.\n");
1228 }
1229
1230 /* Win32 version of capturing a directory tree */
1231 int
1232 win32_build_dentry_tree(struct wim_dentry **root_ret,
1233                         const wchar_t *root_disk_path,
1234                         struct add_image_params *params)
1235 {
1236         size_t path_nchars;
1237         wchar_t *path;
1238         int ret;
1239         struct win32_capture_state state;
1240         unsigned vol_flags;
1241
1242
1243         path_nchars = wcslen(root_disk_path);
1244         if (path_nchars > 32767)
1245                 return WIMLIB_ERR_INVALID_PARAM;
1246
1247         ret = win32_get_file_and_vol_ids(root_disk_path,
1248                                          &params->capture_root_ino,
1249                                          &params->capture_root_dev);
1250         if (ret)
1251                 return ret;
1252
1253         win32_get_vol_flags(root_disk_path, &vol_flags);
1254
1255         /* There is no check for overflow later when this buffer is being used!
1256          * But the max path length on NTFS is 32767 characters, and paths need
1257          * to be written specially to even go past 260 characters, so we should
1258          * be okay with 32770 characters. */
1259         path = MALLOC(32770 * sizeof(wchar_t));
1260         if (!path)
1261                 return WIMLIB_ERR_NOMEM;
1262
1263         wmemcpy(path, root_disk_path, path_nchars + 1);
1264
1265         memset(&state, 0, sizeof(state));
1266         ret = win32_build_dentry_tree_recursive(root_ret, path,
1267                                                 path_nchars, params,
1268                                                 &state, vol_flags);
1269         FREE(path);
1270         if (ret == 0)
1271                 win32_do_capture_warnings(&state, params->add_image_flags);
1272         return ret;
1273 }
1274
1275 static int
1276 win32_set_reparse_data(HANDLE h,
1277                        u32 reparse_tag,
1278                        const struct wim_lookup_table_entry *lte,
1279                        const wchar_t *path)
1280 {
1281         int ret;
1282         u8 *buf;
1283         size_t len;
1284
1285         if (!lte) {
1286                 WARNING("\"%ls\" is marked as a reparse point but had no reparse data",
1287                         path);
1288                 return 0;
1289         }
1290         len = wim_resource_size(lte);
1291         if (len > 16 * 1024 - 8) {
1292                 WARNING("\"%ls\": reparse data too long!", path);
1293                 return 0;
1294         }
1295
1296         /* The WIM stream omits the ReparseTag and ReparseDataLength fields, so
1297          * leave 8 bytes of space for them at the beginning of the buffer, then
1298          * set them manually. */
1299         buf = alloca(len + 8);
1300         ret = read_full_resource_into_buf(lte, buf + 8, false);
1301         if (ret)
1302                 return ret;
1303         *(u32*)(buf + 0) = cpu_to_le32(reparse_tag);
1304         *(u16*)(buf + 4) = cpu_to_le16(len);
1305         *(u16*)(buf + 6) = 0;
1306
1307         /* Set the reparse data on the open file using the
1308          * FSCTL_SET_REPARSE_POINT ioctl.
1309          *
1310          * There are contradictions in Microsoft's documentation for this:
1311          *
1312          * "If hDevice was opened without specifying FILE_FLAG_OVERLAPPED,
1313          * lpOverlapped is ignored."
1314          *
1315          * --- So setting lpOverlapped to NULL is okay since it's ignored.
1316          *
1317          * "If lpOverlapped is NULL, lpBytesReturned cannot be NULL. Even when an
1318          * operation returns no output data and lpOutBuffer is NULL,
1319          * DeviceIoControl makes use of lpBytesReturned. After such an
1320          * operation, the value of lpBytesReturned is meaningless."
1321          *
1322          * --- So lpOverlapped not really ignored, as it affects another
1323          *  parameter.  This is the actual behavior: lpBytesReturned must be
1324          *  specified, even though lpBytesReturned is documented as:
1325          *
1326          *  "Not used with this operation; set to NULL."
1327          */
1328         DWORD bytesReturned;
1329         if (!DeviceIoControl(h, FSCTL_SET_REPARSE_POINT, buf, len + 8,
1330                              NULL, 0,
1331                              &bytesReturned /* lpBytesReturned */,
1332                              NULL /* lpOverlapped */))
1333         {
1334                 DWORD err = GetLastError();
1335                 ERROR("Failed to set reparse data on \"%ls\"", path);
1336                 win32_error(err);
1337                 return WIMLIB_ERR_WRITE;
1338         }
1339         return 0;
1340 }
1341
1342 static int
1343 win32_set_compressed(HANDLE hFile, const wchar_t *path)
1344 {
1345         USHORT format = COMPRESSION_FORMAT_DEFAULT;
1346         DWORD bytesReturned = 0;
1347         if (!DeviceIoControl(hFile, FSCTL_SET_COMPRESSION,
1348                              &format, sizeof(USHORT),
1349                              NULL, 0,
1350                              &bytesReturned, NULL))
1351         {
1352                 /* Could be a warning only, but we only call this if the volume
1353                  * supports compression.  So I'm calling this an error. */
1354                 DWORD err = GetLastError();
1355                 ERROR("Failed to set compression flag on \"%ls\"", path);
1356                 win32_error(err);
1357                 return WIMLIB_ERR_WRITE;
1358         }
1359         return 0;
1360 }
1361
1362 static int
1363 win32_set_sparse(HANDLE hFile, const wchar_t *path)
1364 {
1365         DWORD bytesReturned = 0;
1366         if (!DeviceIoControl(hFile, FSCTL_SET_SPARSE,
1367                              NULL, 0,
1368                              NULL, 0,
1369                              &bytesReturned, NULL))
1370         {
1371                 /* Could be a warning only, but we only call this if the volume
1372                  * supports sparse files.  So I'm calling this an error. */
1373                 DWORD err = GetLastError();
1374                 WARNING("Failed to set sparse flag on \"%ls\"", path);
1375                 win32_error(err);
1376                 return WIMLIB_ERR_WRITE;
1377         }
1378         return 0;
1379 }
1380
1381 /*
1382  * Sets the security descriptor on an extracted file.
1383  */
1384 static int
1385 win32_set_security_data(const struct wim_inode *inode,
1386                         const wchar_t *path,
1387                         struct apply_args *args)
1388 {
1389         PSECURITY_DESCRIPTOR descriptor;
1390         unsigned long n;
1391         DWORD err;
1392
1393         descriptor = wim_const_security_data(args->w)->descriptors[inode->i_security_id];
1394
1395         SECURITY_INFORMATION securityInformation = DACL_SECURITY_INFORMATION |
1396                                                    SACL_SECURITY_INFORMATION |
1397                                                    OWNER_SECURITY_INFORMATION |
1398                                                    GROUP_SECURITY_INFORMATION;
1399 again:
1400         if (SetFileSecurityW(path, securityInformation, descriptor))
1401                 return 0;
1402         err = GetLastError();
1403         if (args->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS)
1404                 goto fail;
1405         switch (err) {
1406         case ERROR_PRIVILEGE_NOT_HELD:
1407                 if (securityInformation & SACL_SECURITY_INFORMATION) {
1408                         n = args->num_set_sacl_priv_notheld++;
1409                         securityInformation &= ~SACL_SECURITY_INFORMATION;
1410                         if (n < MAX_SET_SACL_PRIV_NOTHELD_WARNINGS) {
1411                                 WARNING(
1412 "We don't have enough privileges to set the full security\n"
1413 "          descriptor on \"%ls\"!\n", path);
1414                                 if (args->num_set_sd_access_denied +
1415                                     args->num_set_sacl_priv_notheld == 1)
1416                                 {
1417                                         WARNING("%ls", apply_access_denied_msg);
1418                                 }
1419                                 WARNING("Re-trying with SACL omitted.\n", path);
1420                         } else if (n == MAX_GET_SACL_PRIV_NOTHELD_WARNINGS) {
1421                                 WARNING(
1422 "Suppressing further 'privileges not held' error messages when setting\n"
1423 "          security descriptors.");
1424                         }
1425                         goto again;
1426                 }
1427                 /* Fall through */
1428         case ERROR_INVALID_OWNER:
1429         case ERROR_ACCESS_DENIED:
1430                 n = args->num_set_sd_access_denied++;
1431                 if (n < MAX_SET_SD_ACCESS_DENIED_WARNINGS) {
1432                         WARNING("Failed to set security descriptor on \"%ls\": "
1433                                 "Access denied!\n", path);
1434                         if (args->num_set_sd_access_denied +
1435                             args->num_set_sacl_priv_notheld == 1)
1436                         {
1437                                 WARNING("%ls", apply_access_denied_msg);
1438                         }
1439                 } else if (n == MAX_SET_SD_ACCESS_DENIED_WARNINGS) {
1440                         WARNING(
1441 "Suppressing further access denied error messages when setting\n"
1442 "          security descriptors");
1443                 }
1444                 return 0;
1445         default:
1446 fail:
1447                 ERROR("Failed to set security descriptor on \"%ls\"", path);
1448                 win32_error(err);
1449                 return WIMLIB_ERR_WRITE;
1450         }
1451 }
1452
1453
1454 static int
1455 win32_extract_chunk(const void *buf, size_t len, void *arg)
1456 {
1457         HANDLE hStream = arg;
1458
1459         DWORD nbytes_written;
1460         wimlib_assert(len <= 0xffffffff);
1461
1462         if (!WriteFile(hStream, buf, len, &nbytes_written, NULL) ||
1463             nbytes_written != len)
1464         {
1465                 DWORD err = GetLastError();
1466                 ERROR("WriteFile(): write error");
1467                 win32_error(err);
1468                 return WIMLIB_ERR_WRITE;
1469         }
1470         return 0;
1471 }
1472
1473 static int
1474 do_win32_extract_stream(HANDLE hStream, struct wim_lookup_table_entry *lte)
1475 {
1476         return extract_wim_resource(lte, wim_resource_size(lte),
1477                                     win32_extract_chunk, hStream);
1478 }
1479
1480 static int
1481 do_win32_extract_encrypted_stream(const wchar_t *path,
1482                                   const struct wim_lookup_table_entry *lte)
1483 {
1484         ERROR("Extracting encryted streams not implemented");
1485         return WIMLIB_ERR_INVALID_PARAM;
1486 }
1487
1488 static bool
1489 path_is_root_of_drive(const wchar_t *path)
1490 {
1491         if (!*path)
1492                 return false;
1493
1494         if (*path != L'/' && *path != L'\\') {
1495                 if (*(path + 1) == L':')
1496                         path += 2;
1497                 else
1498                         return false;
1499         }
1500         while (*path == L'/' || *path == L'\\')
1501                 path++;
1502         return (*path == L'\0');
1503 }
1504
1505 static DWORD
1506 win32_get_create_flags_and_attributes(DWORD i_attributes)
1507 {
1508         DWORD attributes;
1509
1510         /*
1511          * Some attributes cannot be set by passing them to CreateFile().  In
1512          * particular:
1513          *
1514          * FILE_ATTRIBUTE_DIRECTORY:
1515          *   CreateDirectory() must be called instead of CreateFile().
1516          *
1517          * FILE_ATTRIBUTE_SPARSE_FILE:
1518          *   Needs an ioctl.
1519          *   See: win32_set_sparse().
1520          *
1521          * FILE_ATTRIBUTE_COMPRESSED:
1522          *   Not clear from the documentation, but apparently this needs an
1523          *   ioctl as well.
1524          *   See: win32_set_compressed().
1525          *
1526          * FILE_ATTRIBUTE_REPARSE_POINT:
1527          *   Needs an ioctl, with the reparse data specified.
1528          *   See: win32_set_reparse_data().
1529          *
1530          * In addition, clear any file flags in the attributes that we don't
1531          * want, but also specify FILE_FLAG_OPEN_REPARSE_POINT and
1532          * FILE_FLAG_BACKUP_SEMANTICS as we are a backup application.
1533          */
1534         attributes = i_attributes & ~(FILE_ATTRIBUTE_SPARSE_FILE |
1535                                       FILE_ATTRIBUTE_COMPRESSED |
1536                                       FILE_ATTRIBUTE_REPARSE_POINT |
1537                                       FILE_ATTRIBUTE_DIRECTORY |
1538                                       FILE_FLAG_DELETE_ON_CLOSE |
1539                                       FILE_FLAG_NO_BUFFERING |
1540                                       FILE_FLAG_OPEN_NO_RECALL |
1541                                       FILE_FLAG_OVERLAPPED |
1542                                       FILE_FLAG_RANDOM_ACCESS |
1543                                       /*FILE_FLAG_SESSION_AWARE |*/
1544                                       FILE_FLAG_SEQUENTIAL_SCAN |
1545                                       FILE_FLAG_WRITE_THROUGH);
1546         return attributes |
1547                FILE_FLAG_OPEN_REPARSE_POINT |
1548                FILE_FLAG_BACKUP_SEMANTICS;
1549 }
1550
1551 static bool
1552 inode_has_special_attributes(const struct wim_inode *inode)
1553 {
1554         return (inode->i_attributes & (FILE_ATTRIBUTE_COMPRESSED |
1555                                        FILE_ATTRIBUTE_REPARSE_POINT |
1556                                        FILE_ATTRIBUTE_SPARSE_FILE)) != 0;
1557 }
1558
1559 /* Set compression or sparse attributes, and reparse data, if supported by the
1560  * volume. */
1561 static int
1562 win32_set_special_attributes(HANDLE hFile, const struct wim_inode *inode,
1563                              struct wim_lookup_table_entry *unnamed_stream_lte,
1564                              const wchar_t *path, unsigned vol_flags)
1565 {
1566         int ret;
1567
1568         if (inode->i_attributes & FILE_ATTRIBUTE_COMPRESSED) {
1569                 if (vol_flags & FILE_FILE_COMPRESSION) {
1570                         DEBUG("Setting compression flag on \"%ls\"", path);
1571                         ret = win32_set_compressed(hFile, path);
1572                         if (ret)
1573                                 return ret;
1574                 } else {
1575                         DEBUG("Cannot set compression attribute on \"%ls\": "
1576                               "volume does not support transparent compression",
1577                               path);
1578                 }
1579         }
1580
1581         if (inode->i_attributes & FILE_ATTRIBUTE_SPARSE_FILE) {
1582                 if (vol_flags & FILE_SUPPORTS_SPARSE_FILES) {
1583                         DEBUG("Setting sparse flag on \"%ls\"", path);
1584                         ret = win32_set_sparse(hFile, path);
1585                         if (ret)
1586                                 return ret;
1587                 } else {
1588                         DEBUG("Cannot set sparse attribute on \"%ls\": "
1589                               "volume does not support sparse files",
1590                               path);
1591                 }
1592         }
1593
1594         if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
1595                 if (vol_flags & FILE_SUPPORTS_REPARSE_POINTS) {
1596                         DEBUG("Setting reparse data on \"%ls\"", path);
1597                         ret = win32_set_reparse_data(hFile, inode->i_reparse_tag,
1598                                                      unnamed_stream_lte, path);
1599                         if (ret)
1600                                 return ret;
1601                 } else {
1602                         DEBUG("Cannot set reparse data on \"%ls\": volume "
1603                               "does not support reparse points", path);
1604                 }
1605         }
1606
1607         return 0;
1608 }
1609
1610 static int
1611 win32_extract_stream(const struct wim_inode *inode,
1612                      const wchar_t *path,
1613                      const wchar_t *stream_name_utf16,
1614                      struct wim_lookup_table_entry *lte,
1615                      unsigned vol_flags)
1616 {
1617         wchar_t *stream_path;
1618         HANDLE h;
1619         int ret;
1620         DWORD err;
1621         DWORD creationDisposition = CREATE_ALWAYS;
1622
1623         if (stream_name_utf16) {
1624                 /* Named stream.  Create a buffer that contains the UTF-16LE
1625                  * string [.\]@path:@stream_name_utf16.  This is needed to
1626                  * create and open the stream using CreateFileW().  I'm not
1627                  * aware of any other APIs to do this.  Note: the '$DATA' suffix
1628                  * seems to be unneeded.  Additional note: a "./" prefix needs
1629                  * to be added when the path is not absolute to avoid ambiguity
1630                  * with drive letters. */
1631                 size_t stream_path_nchars;
1632                 size_t path_nchars;
1633                 size_t stream_name_nchars;
1634                 const wchar_t *prefix;
1635
1636                 path_nchars = wcslen(path);
1637                 stream_name_nchars = wcslen(stream_name_utf16);
1638                 stream_path_nchars = path_nchars + 1 + stream_name_nchars;
1639                 if (path[0] != cpu_to_le16(L'\0') &&
1640                     path[0] != cpu_to_le16(L'/') &&
1641                     path[0] != cpu_to_le16(L'\\') &&
1642                     path[1] != cpu_to_le16(L':'))
1643                 {
1644                         prefix = L"./";
1645                         stream_path_nchars += 2;
1646                 } else {
1647                         prefix = L"";
1648                 }
1649                 stream_path = alloca((stream_path_nchars + 1) * sizeof(wchar_t));
1650                 swprintf(stream_path, L"%ls%ls:%ls",
1651                          prefix, path, stream_name_utf16);
1652         } else {
1653                 /* Unnamed stream; its path is just the path to the file itself.
1654                  * */
1655                 stream_path = (wchar_t*)path;
1656
1657                 /* Directories must be created with CreateDirectoryW().  Then
1658                  * the call to CreateFileW() will merely open the directory that
1659                  * was already created rather than creating a new file. */
1660                 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) {
1661                         if (!CreateDirectoryW(stream_path, NULL)) {
1662                                 err = GetLastError();
1663                                 switch (err) {
1664                                 case ERROR_ALREADY_EXISTS:
1665                                         break;
1666                                 case ERROR_ACCESS_DENIED:
1667                                         if (path_is_root_of_drive(path))
1668                                                 break;
1669                                         /* Fall through */
1670                                 default:
1671                                         ERROR("Failed to create directory \"%ls\"",
1672                                               stream_path);
1673                                         win32_error(err);
1674                                         ret = WIMLIB_ERR_MKDIR;
1675                                         goto fail;
1676                                 }
1677                         }
1678                         DEBUG("Created directory \"%ls\"", stream_path);
1679                         if (!inode_has_special_attributes(inode)) {
1680                                 ret = 0;
1681                                 goto out;
1682                         }
1683                         DEBUG("Directory \"%ls\" has special attributes!",
1684                               stream_path);
1685                         creationDisposition = OPEN_EXISTING;
1686                 }
1687         }
1688
1689         DEBUG("Opening \"%ls\"", stream_path);
1690         h = CreateFileW(stream_path,
1691                         GENERIC_READ | GENERIC_WRITE,
1692                         0,
1693                         NULL,
1694                         creationDisposition,
1695                         win32_get_create_flags_and_attributes(inode->i_attributes),
1696                         NULL);
1697         if (h == INVALID_HANDLE_VALUE) {
1698                 err = GetLastError();
1699                 ERROR("Failed to create \"%ls\"", stream_path);
1700                 win32_error(err);
1701                 ret = WIMLIB_ERR_OPEN;
1702                 goto fail;
1703         }
1704
1705         if (stream_name_utf16 == NULL && inode_has_special_attributes(inode)) {
1706                 ret = win32_set_special_attributes(h, inode, lte, path,
1707                                                    vol_flags);
1708                 if (ret)
1709                         goto fail_close_handle;
1710         }
1711
1712         if (!(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)) {
1713                 if (lte) {
1714                         DEBUG("Extracting \"%ls\" (len = %"PRIu64")",
1715                               stream_path, wim_resource_size(lte));
1716                         if (inode->i_attributes & FILE_ATTRIBUTE_ENCRYPTED
1717                             && stream_name_utf16 == NULL
1718                             && (vol_flags & FILE_SUPPORTS_ENCRYPTION))
1719                         {
1720                                 ret = do_win32_extract_encrypted_stream(stream_path,
1721                                                                         lte);
1722                         } else {
1723                                 ret = do_win32_extract_stream(h, lte);
1724                         }
1725                         if (ret)
1726                                 goto fail_close_handle;
1727                 }
1728         }
1729
1730         DEBUG("Closing \"%ls\"", stream_path);
1731         if (!CloseHandle(h)) {
1732                 err = GetLastError();
1733                 ERROR("Failed to close \"%ls\"", stream_path);
1734                 win32_error(err);
1735                 ret = WIMLIB_ERR_WRITE;
1736                 goto fail;
1737         }
1738         ret = 0;
1739         goto out;
1740 fail_close_handle:
1741         CloseHandle(h);
1742 fail:
1743         ERROR("Error extracting %ls", stream_path);
1744 out:
1745         return ret;
1746 }
1747
1748 /*
1749  * Creates a file, directory, or reparse point and extracts all streams to it
1750  * (unnamed data stream and/or reparse point stream, plus any alternate data
1751  * streams).  This in Win32-specific code.
1752  *
1753  * @inode:      WIM inode for this file or directory.
1754  * @path:       UTF-16LE external path to extract the inode to.
1755  *
1756  * Returns 0 on success; nonzero on failure.
1757  */
1758 static int
1759 win32_extract_streams(const struct wim_inode *inode,
1760                       const wchar_t *path, u64 *completed_bytes_p,
1761                       unsigned vol_flags)
1762 {
1763         struct wim_lookup_table_entry *unnamed_lte;
1764         int ret;
1765
1766         unnamed_lte = inode_unnamed_lte_resolved(inode);
1767         ret = win32_extract_stream(inode, path, NULL, unnamed_lte,
1768                                    vol_flags);
1769         if (ret)
1770                 goto out;
1771         if (unnamed_lte && inode->i_extracted_file == NULL)
1772                 *completed_bytes_p += wim_resource_size(unnamed_lte);
1773
1774         if (!(vol_flags & FILE_NAMED_STREAMS))
1775                 goto out;
1776         for (u16 i = 0; i < inode->i_num_ads; i++) {
1777                 const struct wim_ads_entry *ads_entry = &inode->i_ads_entries[i];
1778                 if (ads_entry->stream_name_nbytes != 0) {
1779                         /* Skip special UNIX data entries (see documentation for
1780                          * WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA) */
1781                         if (ads_entry->stream_name_nbytes == WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES
1782                             && !memcmp(ads_entry->stream_name,
1783                                        WIMLIB_UNIX_DATA_TAG_UTF16LE,
1784                                        WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES))
1785                                 continue;
1786                         ret = win32_extract_stream(inode,
1787                                                    path,
1788                                                    ads_entry->stream_name,
1789                                                    ads_entry->lte,
1790                                                    vol_flags);
1791                         if (ret)
1792                                 break;
1793                         if (ads_entry->lte && inode->i_extracted_file == NULL)
1794                                 *completed_bytes_p += wim_resource_size(ads_entry->lte);
1795                 }
1796         }
1797 out:
1798         return ret;
1799 }
1800
1801 /* Extract a file, directory, reparse point, or hard link to an
1802  * already-extracted file using the Win32 API */
1803 int
1804 win32_do_apply_dentry(const wchar_t *output_path,
1805                       size_t output_path_num_chars,
1806                       struct wim_dentry *dentry,
1807                       struct apply_args *args)
1808 {
1809         int ret;
1810         struct wim_inode *inode = dentry->d_inode;
1811         DWORD err;
1812
1813         if (!args->have_vol_flags) {
1814                 win32_get_vol_flags(output_path, &args->vol_flags);
1815                 args->have_vol_flags = true;
1816                 /* Warn the user about data that may not be extracted. */
1817                 if (!(args->vol_flags & FILE_SUPPORTS_SPARSE_FILES))
1818                         WARNING("Volume does not support sparse files!\n"
1819                                 "          Sparse files will be extracted as non-sparse.");
1820                 if (!(args->vol_flags & FILE_SUPPORTS_REPARSE_POINTS))
1821                         WARNING("Volume does not support reparse points!\n"
1822                                 "          Reparse point data will not be extracted.");
1823                 if (!(args->vol_flags & FILE_NAMED_STREAMS)) {
1824                         WARNING("Volume does not support named data streams!\n"
1825                                 "          Named data streams will not be extracted.");
1826                 }
1827                 if (!(args->vol_flags & FILE_SUPPORTS_ENCRYPTION)) {
1828                         WARNING("Volume does not support encryption!\n"
1829                                 "          Encrypted files will be extracted as raw data.");
1830                 }
1831                 if (!(args->vol_flags & FILE_FILE_COMPRESSION)) {
1832                         WARNING("Volume does not support transparent compression!\n"
1833                                 "          Compressed files will be extracted as non-compressed.");
1834                 }
1835                 if (!(args->vol_flags & FILE_PERSISTENT_ACLS)) {
1836                         if (args->extract_flags & WIMLIB_EXTRACT_FLAG_STRICT_ACLS) {
1837                                 ERROR("Strict ACLs requested, but the volume does not "
1838                                       "support ACLs!");
1839                                 return WIMLIB_ERR_VOLUME_LACKS_FEATURES;
1840                         } else {
1841                                 WARNING("Volume does not support persistent ACLS!\n"
1842                                         "          File permissions will not be extracted.");
1843                         }
1844                 }
1845         }
1846
1847         if (inode->i_nlink > 1 && inode->i_extracted_file != NULL) {
1848                 /* Linked file, with another name already extracted.  Create a
1849                  * hard link. */
1850
1851                 /* There is a volume flag for this (FILE_SUPPORTS_HARD_LINKS),
1852                  * but it's only available on Windows 7 and later.  So no use
1853                  * even checking it, really.  Instead, CreateHardLinkW() will
1854                  * apparently return ERROR_INVALID_FUNCTION if the volume does
1855                  * not support hard links. */
1856                 DEBUG("Creating hard link \"%ls => %ls\"",
1857                       output_path, inode->i_extracted_file);
1858                 if (CreateHardLinkW(output_path, inode->i_extracted_file, NULL))
1859                         return 0;
1860
1861                 err = GetLastError();
1862                 if (err != ERROR_INVALID_FUNCTION) {
1863                         ERROR("Can't create hard link \"%ls => %ls\"",
1864                               output_path, inode->i_extracted_file);
1865                         win32_error(err);
1866                         return WIMLIB_ERR_LINK;
1867                 } else {
1868                         args->num_hard_links_failed++;
1869                         if (args->num_hard_links_failed < MAX_CREATE_HARD_LINK_WARNINGS) {
1870                                 WARNING("Can't create hard link \"%ls => %ls\":\n"
1871                                         "          Volume does not support hard links!\n"
1872                                         "          Falling back to extracting a copy of the file.",
1873                                         output_path, inode->i_extracted_file);
1874                         } else if (args->num_hard_links_failed == MAX_CREATE_HARD_LINK_WARNINGS) {
1875                                 WARNING("Suppressing further hard linking warnings...");
1876                         }
1877                 }
1878         }
1879
1880         if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT &&
1881             !(args->vol_flags & FILE_SUPPORTS_REPARSE_POINTS))
1882         {
1883                 WARNING("Skipping extraction of reparse point \"%ls\":\n"
1884                         "          Not supported by destination filesystem",
1885                         output_path);
1886                 struct wim_lookup_table_entry *lte;
1887                 lte = inode_unnamed_lte_resolved(inode);
1888                 if (lte)
1889                         args->progress.extract.completed_bytes += wim_resource_size(lte);
1890                 return 0;
1891         }
1892
1893         /* Create the file, directory, or reparse point, and extract the
1894          * data streams. */
1895         ret = win32_extract_streams(inode, output_path,
1896                                     &args->progress.extract.completed_bytes,
1897                                     args->vol_flags);
1898         if (ret)
1899                 return ret;
1900
1901         if (inode->i_security_id >= 0 &&
1902             !(args->extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS)
1903             && (args->vol_flags & FILE_PERSISTENT_ACLS))
1904         {
1905                 ret = win32_set_security_data(inode, output_path, args);
1906                 if (ret)
1907                         return ret;
1908         }
1909         if (inode->i_nlink > 1) {
1910                 /* Save extracted path for a later call to
1911                  * CreateHardLinkW() if this inode has multiple links.
1912                  * */
1913                 inode->i_extracted_file = WSTRDUP(output_path);
1914                 if (!inode->i_extracted_file)
1915                         ret = WIMLIB_ERR_NOMEM;
1916         }
1917         return 0;
1918 }
1919
1920 /* Set timestamps on an extracted file using the Win32 API */
1921 int
1922 win32_do_apply_dentry_timestamps(const wchar_t *path,
1923                                  size_t path_num_chars,
1924                                  const struct wim_dentry *dentry,
1925                                  const struct apply_args *args)
1926 {
1927         DWORD err;
1928         HANDLE h;
1929         const struct wim_inode *inode = dentry->d_inode;
1930
1931         if (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT &&
1932             !(args->vol_flags & FILE_SUPPORTS_REPARSE_POINTS))
1933         {
1934                 /* Skip reparse points not extracted */
1935                 return 0;
1936         }
1937
1938         /* Windows doesn't let you change the timestamps of the root directory
1939          * (at least on FAT, which is dumb but expected since FAT doesn't store
1940          * any metadata about the root directory...) */
1941         if (path_is_root_of_drive(path))
1942                 return 0;
1943
1944         DEBUG("Opening \"%ls\" to set timestamps", path);
1945         h = win32_open_existing_file(path, FILE_WRITE_ATTRIBUTES);
1946         if (h == INVALID_HANDLE_VALUE) {
1947                 err = GetLastError();
1948                 goto fail;
1949         }
1950
1951         FILETIME creationTime = {.dwLowDateTime = inode->i_creation_time & 0xffffffff,
1952                                  .dwHighDateTime = inode->i_creation_time >> 32};
1953         FILETIME lastAccessTime = {.dwLowDateTime = inode->i_last_access_time & 0xffffffff,
1954                                   .dwHighDateTime = inode->i_last_access_time >> 32};
1955         FILETIME lastWriteTime = {.dwLowDateTime = inode->i_last_write_time & 0xffffffff,
1956                                   .dwHighDateTime = inode->i_last_write_time >> 32};
1957
1958         DEBUG("Calling SetFileTime() on \"%ls\"", path);
1959         if (!SetFileTime(h, &creationTime, &lastAccessTime, &lastWriteTime)) {
1960                 err = GetLastError();
1961                 CloseHandle(h);
1962                 goto fail;
1963         }
1964         DEBUG("Closing \"%ls\"", path);
1965         if (!CloseHandle(h)) {
1966                 err = GetLastError();
1967                 goto fail;
1968         }
1969         goto out;
1970 fail:
1971         /* Only warn if setting timestamps failed; still return 0. */
1972         WARNING("Can't set timestamps on \"%ls\"", path);
1973         win32_error(err);
1974 out:
1975         return 0;
1976 }
1977
1978 /* Replacement for POSIX fsync() */
1979 int
1980 fsync(int fd)
1981 {
1982         DWORD err;
1983         HANDLE h;
1984
1985         h = (HANDLE)_get_osfhandle(fd);
1986         if (h == INVALID_HANDLE_VALUE) {
1987                 err = GetLastError();
1988                 ERROR("Could not get Windows handle for file descriptor");
1989                 win32_error(err);
1990                 errno = EBADF;
1991                 return -1;
1992         }
1993         if (!FlushFileBuffers(h)) {
1994                 err = GetLastError();
1995                 ERROR("Could not flush file buffers to disk");
1996                 win32_error(err);
1997                 errno = EIO;
1998                 return -1;
1999         }
2000         return 0;
2001 }
2002
2003 /* Use the Win32 API to get the number of processors */
2004 unsigned
2005 win32_get_number_of_processors()
2006 {
2007         SYSTEM_INFO sysinfo;
2008         GetSystemInfo(&sysinfo);
2009         return sysinfo.dwNumberOfProcessors;
2010 }
2011
2012 /* Replacement for POSIX-2008 realpath().  Warning: partial functionality only
2013  * (resolved_path must be NULL).   Also I highly doubt that GetFullPathName
2014  * really does the right thing under all circumstances. */
2015 wchar_t *
2016 realpath(const wchar_t *path, wchar_t *resolved_path)
2017 {
2018         DWORD ret;
2019         wimlib_assert(resolved_path == NULL);
2020         DWORD err;
2021
2022         ret = GetFullPathNameW(path, 0, NULL, NULL);
2023         if (!ret) {
2024                 err = GetLastError();
2025                 goto fail_win32;
2026         }
2027
2028         resolved_path = TMALLOC(ret);
2029         if (!resolved_path)
2030                 goto out;
2031         ret = GetFullPathNameW(path, ret, resolved_path, NULL);
2032         if (!ret) {
2033                 err = GetLastError();
2034                 free(resolved_path);
2035                 resolved_path = NULL;
2036                 goto fail_win32;
2037         }
2038         goto out;
2039 fail_win32:
2040         win32_error(err);
2041         errno = -1;
2042 out:
2043         return resolved_path;
2044 }
2045
2046 /* rename() on Windows fails if the destination file exists.  And we need to
2047  * make it work on wide characters.  Fix it. */
2048 int
2049 win32_rename_replacement(const wchar_t *oldpath, const wchar_t *newpath)
2050 {
2051         if (MoveFileExW(oldpath, newpath, MOVEFILE_REPLACE_EXISTING)) {
2052                 return 0;
2053         } else {
2054                 /* As usual, the possible error values are not documented */
2055                 DWORD err = GetLastError();
2056                 ERROR("MoveFileEx(): Can't rename \"%ls\" to \"%ls\"",
2057                       oldpath, newpath);
2058                 win32_error(err);
2059                 errno = -1;
2060                 return -1;
2061         }
2062 }
2063
2064 /* Replacement for POSIX fnmatch() (partial functionality only) */
2065 int
2066 fnmatch(const wchar_t *pattern, const wchar_t *string, int flags)
2067 {
2068         if (PathMatchSpecW(string, pattern))
2069                 return 0;
2070         else
2071                 return FNM_NOMATCH;
2072 }
2073
2074 /* truncate() replacement */
2075 int
2076 win32_truncate_replacement(const wchar_t *path, off_t size)
2077 {
2078         DWORD err = NO_ERROR;
2079         LARGE_INTEGER liOffset;
2080
2081         HANDLE h = win32_open_existing_file(path, GENERIC_WRITE);
2082         if (h == INVALID_HANDLE_VALUE)
2083                 goto fail;
2084
2085         liOffset.QuadPart = size;
2086         if (!SetFilePointerEx(h, liOffset, NULL, FILE_BEGIN))
2087                 goto fail_close_handle;
2088
2089         if (!SetEndOfFile(h))
2090                 goto fail_close_handle;
2091         CloseHandle(h);
2092         return 0;
2093
2094 fail_close_handle:
2095         err = GetLastError();
2096         CloseHandle(h);
2097 fail:
2098         if (err == NO_ERROR)
2099                 err = GetLastError();
2100         ERROR("Can't truncate \"%ls\" to %"PRIu64" bytes", path, size);
2101         win32_error(err);
2102         errno = -1;
2103         return -1;
2104 }
2105
2106
2107 /* This really could be replaced with _wcserror_s, but this doesn't seem to
2108  * actually be available in MSVCRT.DLL on Windows XP (perhaps it's statically
2109  * linked in by Visual Studio...?). */
2110 extern int
2111 win32_strerror_r_replacement(int errnum, wchar_t *buf, size_t buflen)
2112 {
2113         static pthread_mutex_t strerror_lock = PTHREAD_MUTEX_INITIALIZER;
2114
2115         pthread_mutex_lock(&strerror_lock);
2116         mbstowcs(buf, strerror(errnum), buflen);
2117         buf[buflen - 1] = '\0';
2118         pthread_mutex_unlock(&strerror_lock);
2119         return 0;
2120 }
2121
2122 #endif /* __WIN32__ */