src/libstd/sys/windows/fs.rs

   1 // Copyright 2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 use io::prelude::*;
  12 use os::windows::prelude::*;
  13
  14 use ffi::OsString;
  15 use fmt;
  16 use io::{self, Error, SeekFrom};
  17 use mem;
  18 use path::{Path, PathBuf};
  19 use ptr;
  20 use slice;
  21 use sync::Arc;
  22 use sys::handle::Handle;
  23 use sys::{c, cvt};
  24 use sys_common::FromInner;
  25
  26 use super::to_u16s;
  27
  28 pub struct File { handle: Handle }
  29
  30 #[derive(Clone)]
  31 pub struct FileAttr {
  32     data: c::WIN32_FILE_ATTRIBUTE_DATA,
  33     reparse_tag: c::DWORD,
  34 }
  35
  36 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
  37 pub enum FileType {
  38     Dir, File, Symlink, ReparsePoint, MountPoint,
  39 }
  40
  41 pub struct ReadDir {
  42     handle: FindNextFileHandle,
  43     root: Arc<PathBuf>,
  44     first: Option<c::WIN32_FIND_DATAW>,
  45 }
  46
  47 struct FindNextFileHandle(c::HANDLE);
  48
  49 unsafe impl Send for FindNextFileHandle {}
  50 unsafe impl Sync for FindNextFileHandle {}
  51
  52 pub struct DirEntry {
  53     root: Arc<PathBuf>,
  54     data: c::WIN32_FIND_DATAW,
  55 }
  56
  57 #[derive(Clone)]
  58 pub struct OpenOptions {
  59     // generic
  60     read: bool,
  61     write: bool,
  62     append: bool,
  63     truncate: bool,
  64     create: bool,
  65     create_new: bool,
  66     // system-specific
  67     custom_flags: u32,
  68     access_mode: Option<c::DWORD>,
  69     attributes: c::DWORD,
  70     share_mode: c::DWORD,
  71     security_qos_flags: c::DWORD,
  72     security_attributes: usize, // FIXME: should be a reference
  73 }
  74
  75 #[derive(Clone, PartialEq, Eq, Debug)]
  76 pub struct FilePermissions { attrs: c::DWORD }
  77
  78 pub struct DirBuilder;
  79
  80 impl Iterator for ReadDir {
  81     type Item = io::Result<DirEntry>;
  82     fn next(&mut self) -> Option<io::Result<DirEntry>> {
  83         if let Some(first) = self.first.take() {
  84             if let Some(e) = DirEntry::new(&self.root, &first) {
  85                 return Some(Ok(e));
  86             }
  87         }
  88         unsafe {
  89             let mut wfd = mem::zeroed();
  90             loop {
  91                 if c::FindNextFileW(self.handle.0, &mut wfd) == 0 {
  92                     if c::GetLastError() == c::ERROR_NO_MORE_FILES {
  93                         return None
  94                     } else {
  95                         return Some(Err(Error::last_os_error()))
  96                     }
  97                 }
  98                 if let Some(e) = DirEntry::new(&self.root, &wfd) {
  99                     return Some(Ok(e))
 100                 }
 101             }
 102         }
 103     }
 104 }
 105
 106 impl Drop for FindNextFileHandle {
 107     fn drop(&mut self) {
 108         let r = unsafe { c::FindClose(self.0) };
 109         debug_assert!(r != 0);
 110     }
 111 }
 112
 113 impl DirEntry {
 114     fn new(root: &Arc<PathBuf>, wfd: &c::WIN32_FIND_DATAW) -> Option<DirEntry> {
 115         match &wfd.cFileName[0..3] {
 116             // check for '.' and '..'
 117             [46, 0, ..] |
 118             [46, 46, 0, ..] => return None,
 119             _ => {}
 120         }
 121
 122         Some(DirEntry {
 123             root: root.clone(),
 124             data: *wfd,
 125         })
 126     }
 127
 128     pub fn path(&self) -> PathBuf {
 129         self.root.join(&self.file_name())
 130     }
 131
 132     pub fn file_name(&self) -> OsString {
 133         let filename = super::truncate_utf16_at_nul(&self.data.cFileName);
 134         OsString::from_wide(filename)
 135     }
 136
 137     pub fn file_type(&self) -> io::Result<FileType> {
 138         Ok(FileType::new(self.data.dwFileAttributes,
 139                          /* reparse_tag = */ self.data.dwReserved0))
 140     }
 141
 142     pub fn metadata(&self) -> io::Result<FileAttr> {
 143         Ok(FileAttr {
 144             data: c::WIN32_FILE_ATTRIBUTE_DATA {
 145                 dwFileAttributes: self.data.dwFileAttributes,
 146                 ftCreationTime: self.data.ftCreationTime,
 147                 ftLastAccessTime: self.data.ftLastAccessTime,
 148                 ftLastWriteTime: self.data.ftLastWriteTime,
 149                 nFileSizeHigh: self.data.nFileSizeHigh,
 150                 nFileSizeLow: self.data.nFileSizeLow,
 151             },
 152             reparse_tag: self.data.dwReserved0,
 153         })
 154     }
 155 }
 156
 157 impl OpenOptions {
 158     pub fn new() -> OpenOptions {
 159         OpenOptions {
 160             // generic
 161             read: false,
 162             write: false,
 163             append: false,
 164             truncate: false,
 165             create: false,
 166             create_new: false,
 167             // system-specific
 168             custom_flags: 0,
 169             access_mode: None,
 170             share_mode: c::FILE_SHARE_READ | c::FILE_SHARE_WRITE | c::FILE_SHARE_DELETE,
 171             attributes: 0,
 172             security_qos_flags: 0,
 173             security_attributes: 0,
 174         }
 175     }
 176
 177     pub fn read(&mut self, read: bool) { self.read = read; }
 178     pub fn write(&mut self, write: bool) { self.write = write; }
 179     pub fn append(&mut self, append: bool) { self.append = append; }
 180     pub fn truncate(&mut self, truncate: bool) { self.truncate = truncate; }
 181     pub fn create(&mut self, create: bool) { self.create = create; }
 182     pub fn create_new(&mut self, create_new: bool) { self.create_new = create_new; }
 183
 184     pub fn custom_flags(&mut self, flags: u32) { self.custom_flags = flags; }
 185     pub fn access_mode(&mut self, access_mode: u32) { self.access_mode = Some(access_mode); }
 186     pub fn share_mode(&mut self, share_mode: u32) { self.share_mode = share_mode; }
 187     pub fn attributes(&mut self, attrs: u32) { self.attributes = attrs; }
 188     pub fn security_qos_flags(&mut self, flags: u32) { self.security_qos_flags = flags; }
 189     pub fn security_attributes(&mut self, attrs: c::LPSECURITY_ATTRIBUTES) {
 190         self.security_attributes = attrs as usize;
 191     }
 192
 193     fn get_access_mode(&self) -> io::Result<c::DWORD> {
 194         const ERROR_INVALID_PARAMETER: i32 = 87;
 195
 196         match (self.read, self.write, self.append, self.access_mode) {
 197             (_, _, _, Some(mode)) => Ok(mode),
 198             (true,  false, false, None) => Ok(c::GENERIC_READ),
 199             (false, true,  false, None) => Ok(c::GENERIC_WRITE),
 200             (true,  true,  false, None) => Ok(c::GENERIC_READ | c::GENERIC_WRITE),
 201             (false, _,     true,  None) => Ok(c::FILE_GENERIC_WRITE & !c::FILE_WRITE_DATA),
 202             (true,  _,     true,  None) => Ok(c::GENERIC_READ |
 203                                               (c::FILE_GENERIC_WRITE & !c::FILE_WRITE_DATA)),
 204             (false, false, false, None) => Err(Error::from_raw_os_error(ERROR_INVALID_PARAMETER)),
 205         }
 206     }
 207
 208     fn get_creation_mode(&self) -> io::Result<c::DWORD> {
 209         const ERROR_INVALID_PARAMETER: i32 = 87;
 210
 211         match (self.write, self.append) {
 212             (true, false) => {}
 213             (false, false) =>
 214                 if self.truncate || self.create || self.create_new {
 215                     return Err(Error::from_raw_os_error(ERROR_INVALID_PARAMETER));
 216                 },
 217             (_, true) =>
 218                 if self.truncate && !self.create_new {
 219                     return Err(Error::from_raw_os_error(ERROR_INVALID_PARAMETER));
 220                 },
 221         }
 222
 223         Ok(match (self.create, self.truncate, self.create_new) {
 224                 (false, false, false) => c::OPEN_EXISTING,
 225                 (true,  false, false) => c::OPEN_ALWAYS,
 226                 (false, true,  false) => c::TRUNCATE_EXISTING,
 227                 (true,  true,  false) => c::CREATE_ALWAYS,
 228                 (_,      _,    true)  => c::CREATE_NEW,
 229            })
 230     }
 231
 232     fn get_flags_and_attributes(&self) -> c::DWORD {
 233         self.custom_flags |
 234         self.attributes |
 235         self.security_qos_flags |
 236         if self.security_qos_flags != 0 { c::SECURITY_SQOS_PRESENT } else { 0 } |
 237         if self.create_new { c::FILE_FLAG_OPEN_REPARSE_POINT } else { 0 }
 238     }
 239 }
 240
 241 impl File {
 242     fn open_reparse_point(path: &Path, write: bool) -> io::Result<File> {
 243         let mut opts = OpenOptions::new();
 244         opts.read(!write);
 245         opts.write(write);
 246         opts.custom_flags(c::FILE_FLAG_OPEN_REPARSE_POINT |
 247                           c::FILE_FLAG_BACKUP_SEMANTICS);
 248         File::open(path, &opts)
 249     }
 250
 251     pub fn open(path: &Path, opts: &OpenOptions) -> io::Result<File> {
 252         let path = try!(to_u16s(path));
 253         let handle = unsafe {
 254             c::CreateFileW(path.as_ptr(),
 255                            try!(opts.get_access_mode()),
 256                            opts.share_mode,
 257                            opts.security_attributes as *mut _,
 258                            try!(opts.get_creation_mode()),
 259                            opts.get_flags_and_attributes(),
 260                            ptr::null_mut())
 261         };
 262         if handle == c::INVALID_HANDLE_VALUE {
 263             Err(Error::last_os_error())
 264         } else {
 265             Ok(File { handle: Handle::new(handle) })
 266         }
 267     }
 268
 269     pub fn fsync(&self) -> io::Result<()> {
 270         try!(cvt(unsafe { c::FlushFileBuffers(self.handle.raw()) }));
 271         Ok(())
 272     }
 273
 274     pub fn datasync(&self) -> io::Result<()> { self.fsync() }
 275
 276     pub fn truncate(&self, size: u64) -> io::Result<()> {
 277         let mut info = c::FILE_END_OF_FILE_INFO {
 278             EndOfFile: size as c::LARGE_INTEGER,
 279         };
 280         let size = mem::size_of_val(&info);
 281         try!(cvt(unsafe {
 282             c::SetFileInformationByHandle(self.handle.raw(),
 283                                           c::FileEndOfFileInfo,
 284                                           &mut info as *mut _ as *mut _,
 285                                           size as c::DWORD)
 286         }));
 287         Ok(())
 288     }
 289
 290     pub fn file_attr(&self) -> io::Result<FileAttr> {
 291         unsafe {
 292             let mut info: c::BY_HANDLE_FILE_INFORMATION = mem::zeroed();
 293             try!(cvt(c::GetFileInformationByHandle(self.handle.raw(),
 294                                                    &mut info)));
 295             let mut attr = FileAttr {
 296                 data: c::WIN32_FILE_ATTRIBUTE_DATA {
 297                     dwFileAttributes: info.dwFileAttributes,
 298                     ftCreationTime: info.ftCreationTime,
 299                     ftLastAccessTime: info.ftLastAccessTime,
 300                     ftLastWriteTime: info.ftLastWriteTime,
 301                     nFileSizeHigh: info.nFileSizeHigh,
 302                     nFileSizeLow: info.nFileSizeLow,
 303                 },
 304                 reparse_tag: 0,
 305             };
 306             if attr.is_reparse_point() {
 307                 let mut b = [0; c::MAXIMUM_REPARSE_DATA_BUFFER_SIZE];
 308                 if let Ok((_, buf)) = self.reparse_point(&mut b) {
 309                     attr.reparse_tag = buf.ReparseTag;
 310                 }
 311             }
 312             Ok(attr)
 313         }
 314     }
 315
 316     pub fn read(&self, buf: &mut [u8]) -> io::Result<usize> {
 317         self.handle.read(buf)
 318     }
 319
 320     pub fn write(&self, buf: &[u8]) -> io::Result<usize> {
 321         self.handle.write(buf)
 322     }
 323
 324     pub fn flush(&self) -> io::Result<()> { Ok(()) }
 325
 326     pub fn seek(&self, pos: SeekFrom) -> io::Result<u64> {
 327         let (whence, pos) = match pos {
 328             SeekFrom::Start(n) => (c::FILE_BEGIN, n as i64),
 329             SeekFrom::End(n) => (c::FILE_END, n),
 330             SeekFrom::Current(n) => (c::FILE_CURRENT, n),
 331         };
 332         let pos = pos as c::LARGE_INTEGER;
 333         let mut newpos = 0;
 334         try!(cvt(unsafe {
 335             c::SetFilePointerEx(self.handle.raw(), pos,
 336                                 &mut newpos, whence)
 337         }));
 338         Ok(newpos as u64)
 339     }
 340
 341     pub fn handle(&self) -> &Handle { &self.handle }
 342
 343     pub fn into_handle(self) -> Handle { self.handle }
 344
 345     fn reparse_point<'a>(&self,
 346                          space: &'a mut [u8; c::MAXIMUM_REPARSE_DATA_BUFFER_SIZE])
 347                          -> io::Result<(c::DWORD, &'a c::REPARSE_DATA_BUFFER)> {
 348         unsafe {
 349             let mut bytes = 0;
 350             try!(cvt({
 351                 c::DeviceIoControl(self.handle.raw(),
 352                                    c::FSCTL_GET_REPARSE_POINT,
 353                                    ptr::null_mut(),
 354                                    0,
 355                                    space.as_mut_ptr() as *mut _,
 356                                    space.len() as c::DWORD,
 357                                    &mut bytes,
 358                                    ptr::null_mut())
 359             }));
 360             Ok((bytes, &*(space.as_ptr() as *const c::REPARSE_DATA_BUFFER)))
 361         }
 362     }
 363
 364     fn readlink(&self) -> io::Result<PathBuf> {
 365         let mut space = [0u8; c::MAXIMUM_REPARSE_DATA_BUFFER_SIZE];
 366         let (_bytes, buf) = try!(self.reparse_point(&mut space));
 367         if buf.ReparseTag != c::IO_REPARSE_TAG_SYMLINK {
 368             return Err(io::Error::new(io::ErrorKind::Other, "not a symlink"))
 369         }
 370
 371         unsafe {
 372             let info: *const c::SYMBOLIC_LINK_REPARSE_BUFFER =
 373                     &buf.rest as *const _ as *const _;
 374             let path_buffer = &(*info).PathBuffer as *const _ as *const u16;
 375             let subst_off = (*info).SubstituteNameOffset / 2;
 376             let subst_ptr = path_buffer.offset(subst_off as isize);
 377             let subst_len = (*info).SubstituteNameLength / 2;
 378             let subst = slice::from_raw_parts(subst_ptr, subst_len as usize);
 379
 380             Ok(PathBuf::from(OsString::from_wide(subst)))
 381         }
 382     }
 383 }
 384
 385 impl FromInner<c::HANDLE> for File {
 386     fn from_inner(handle: c::HANDLE) -> File {
 387         File { handle: Handle::new(handle) }
 388     }
 389 }
 390
 391 impl fmt::Debug for File {
 392     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 393         // FIXME(#24570): add more info here (e.g. mode)
 394         let mut b = f.debug_struct("File");
 395         b.field("handle", &self.handle.raw());
 396         if let Ok(path) = get_path(&self) {
 397             b.field("path", &path);
 398         }
 399         b.finish()
 400     }
 401 }
 402
 403 impl FileAttr {
 404     pub fn size(&self) -> u64 {
 405         ((self.data.nFileSizeHigh as u64) << 32) | (self.data.nFileSizeLow as u64)
 406     }
 407
 408     pub fn perm(&self) -> FilePermissions {
 409         FilePermissions { attrs: self.data.dwFileAttributes }
 410     }
 411
 412     pub fn attrs(&self) -> u32 { self.data.dwFileAttributes as u32 }
 413
 414     pub fn file_type(&self) -> FileType {
 415         FileType::new(self.data.dwFileAttributes, self.reparse_tag)
 416     }
 417
 418     pub fn created(&self) -> u64 { self.to_u64(&self.data.ftCreationTime) }
 419     pub fn accessed(&self) -> u64 { self.to_u64(&self.data.ftLastAccessTime) }
 420     pub fn modified(&self) -> u64 { self.to_u64(&self.data.ftLastWriteTime) }
 421
 422     fn to_u64(&self, ft: &c::FILETIME) -> u64 {
 423         (ft.dwLowDateTime as u64) | ((ft.dwHighDateTime as u64) << 32)
 424     }
 425
 426     fn is_reparse_point(&self) -> bool {
 427         self.data.dwFileAttributes & c::FILE_ATTRIBUTE_REPARSE_POINT != 0
 428     }
 429 }
 430
 431 impl FilePermissions {
 432     pub fn readonly(&self) -> bool {
 433         self.attrs & c::FILE_ATTRIBUTE_READONLY != 0
 434     }
 435
 436     pub fn set_readonly(&mut self, readonly: bool) {
 437         if readonly {
 438             self.attrs |= c::FILE_ATTRIBUTE_READONLY;
 439         } else {
 440             self.attrs &= !c::FILE_ATTRIBUTE_READONLY;
 441         }
 442     }
 443 }
 444
 445 impl FileType {
 446     fn new(attrs: c::DWORD, reparse_tag: c::DWORD) -> FileType {
 447         if attrs & c::FILE_ATTRIBUTE_REPARSE_POINT != 0 {
 448             match reparse_tag {
 449                 c::IO_REPARSE_TAG_SYMLINK => FileType::Symlink,
 450                 c::IO_REPARSE_TAG_MOUNT_POINT => FileType::MountPoint,
 451                 _ => FileType::ReparsePoint,
 452             }
 453         } else if attrs & c::FILE_ATTRIBUTE_DIRECTORY != 0 {
 454             FileType::Dir
 455         } else {
 456             FileType::File
 457         }
 458     }
 459
 460     pub fn is_dir(&self) -> bool { *self == FileType::Dir }
 461     pub fn is_file(&self) -> bool { *self == FileType::File }
 462     pub fn is_symlink(&self) -> bool {
 463         *self == FileType::Symlink || *self == FileType::MountPoint
 464     }
 465 }
 466
 467 impl DirBuilder {
 468     pub fn new() -> DirBuilder { DirBuilder }
 469
 470     pub fn mkdir(&self, p: &Path) -> io::Result<()> {
 471         let p = try!(to_u16s(p));
 472         try!(cvt(unsafe {
 473             c::CreateDirectoryW(p.as_ptr(), ptr::null_mut())
 474         }));
 475         Ok(())
 476     }
 477 }
 478
 479 pub fn readdir(p: &Path) -> io::Result<ReadDir> {
 480     let root = p.to_path_buf();
 481     let star = p.join("*");
 482     let path = try!(to_u16s(&star));
 483
 484     unsafe {
 485         let mut wfd = mem::zeroed();
 486         let find_handle = c::FindFirstFileW(path.as_ptr(), &mut wfd);
 487         if find_handle != c::INVALID_HANDLE_VALUE {
 488             Ok(ReadDir {
 489                 handle: FindNextFileHandle(find_handle),
 490                 root: Arc::new(root),
 491                 first: Some(wfd),
 492             })
 493         } else {
 494             Err(Error::last_os_error())
 495         }
 496     }
 497 }
 498
 499 pub fn unlink(p: &Path) -> io::Result<()> {
 500     let p_u16s = try!(to_u16s(p));
 501     try!(cvt(unsafe { c::DeleteFileW(p_u16s.as_ptr()) }));
 502     Ok(())
 503 }
 504
 505 pub fn rename(old: &Path, new: &Path) -> io::Result<()> {
 506     let old = try!(to_u16s(old));
 507     let new = try!(to_u16s(new));
 508     try!(cvt(unsafe {
 509         c::MoveFileExW(old.as_ptr(), new.as_ptr(), c::MOVEFILE_REPLACE_EXISTING)
 510     }));
 511     Ok(())
 512 }
 513
 514 pub fn rmdir(p: &Path) -> io::Result<()> {
 515     let p = try!(to_u16s(p));
 516     try!(cvt(unsafe { c::RemoveDirectoryW(p.as_ptr()) }));
 517     Ok(())
 518 }
 519
 520 pub fn readlink(p: &Path) -> io::Result<PathBuf> {
 521     let file = try!(File::open_reparse_point(p, false));
 522     file.readlink()
 523 }
 524
 525 pub fn symlink(src: &Path, dst: &Path) -> io::Result<()> {
 526     symlink_inner(src, dst, false)
 527 }
 528
 529 pub fn symlink_inner(src: &Path, dst: &Path, dir: bool) -> io::Result<()> {
 530     let src = try!(to_u16s(src));
 531     let dst = try!(to_u16s(dst));
 532     let flags = if dir { c::SYMBOLIC_LINK_FLAG_DIRECTORY } else { 0 };
 533     try!(cvt(unsafe {
 534         c::CreateSymbolicLinkW(dst.as_ptr(), src.as_ptr(), flags) as c::BOOL
 535     }));
 536     Ok(())
 537 }
 538
 539 pub fn link(src: &Path, dst: &Path) -> io::Result<()> {
 540     let src = try!(to_u16s(src));
 541     let dst = try!(to_u16s(dst));
 542     try!(cvt(unsafe {
 543         c::CreateHardLinkW(dst.as_ptr(), src.as_ptr(), ptr::null_mut())
 544     }));
 545     Ok(())
 546 }
 547
 548 pub fn stat(p: &Path) -> io::Result<FileAttr> {
 549     let attr = try!(lstat(p));
 550
 551     // If this is a reparse point, then we need to reopen the file to get the
 552     // actual destination. We also pass the FILE_FLAG_BACKUP_SEMANTICS flag to
 553     // ensure that we can open directories (this path may be a directory
 554     // junction). Once the file is opened we ask the opened handle what its
 555     // metadata information is.
 556     if attr.is_reparse_point() {
 557         let mut opts = OpenOptions::new();
 558         // No read or write permissions are necessary
 559         opts.access_mode(0);
 560         // This flag is so we can open directories too
 561         opts.custom_flags(c::FILE_FLAG_BACKUP_SEMANTICS);
 562         let file = try!(File::open(p, &opts));
 563         file.file_attr()
 564     } else {
 565         Ok(attr)
 566     }
 567 }
 568
 569 pub fn lstat(p: &Path) -> io::Result<FileAttr> {
 570     let u16s = try!(to_u16s(p));
 571     unsafe {
 572         let mut attr: FileAttr = mem::zeroed();
 573         try!(cvt(c::GetFileAttributesExW(u16s.as_ptr(),
 574                                          c::GetFileExInfoStandard,
 575                                          &mut attr.data as *mut _ as *mut _)));
 576         if attr.is_reparse_point() {
 577             attr.reparse_tag = File::open_reparse_point(p, false).and_then(|f| {
 578                 let mut b = [0; c::MAXIMUM_REPARSE_DATA_BUFFER_SIZE];
 579                 f.reparse_point(&mut b).map(|(_, b)| b.ReparseTag)
 580             }).unwrap_or(0);
 581         }
 582         Ok(attr)
 583     }
 584 }
 585
 586 pub fn set_perm(p: &Path, perm: FilePermissions) -> io::Result<()> {
 587     let p = try!(to_u16s(p));
 588     unsafe {
 589         try!(cvt(c::SetFileAttributesW(p.as_ptr(), perm.attrs)));
 590         Ok(())
 591     }
 592 }
 593
 594 fn get_path(f: &File) -> io::Result<PathBuf> {
 595     super::fill_utf16_buf(|buf, sz| unsafe {
 596         c::GetFinalPathNameByHandleW(f.handle.raw(), buf, sz,
 597                                      c::VOLUME_NAME_DOS)
 598     }, |buf| {
 599         PathBuf::from(OsString::from_wide(buf))
 600     })
 601 }
 602
 603 pub fn canonicalize(p: &Path) -> io::Result<PathBuf> {
 604     let mut opts = OpenOptions::new();
 605     // No read or write permissions are necessary
 606     opts.access_mode(0);
 607     // This flag is so we can open directories too
 608     opts.custom_flags(c::FILE_FLAG_BACKUP_SEMANTICS);
 609     let f = try!(File::open(p, &opts));
 610     get_path(&f)
 611 }
 612
 613 pub fn copy(from: &Path, to: &Path) -> io::Result<u64> {
 614     unsafe extern "system" fn callback(
 615         _TotalFileSize: c::LARGE_INTEGER,
 616         TotalBytesTransferred: c::LARGE_INTEGER,
 617         _StreamSize: c::LARGE_INTEGER,
 618         _StreamBytesTransferred: c::LARGE_INTEGER,
 619         _dwStreamNumber: c::DWORD,
 620         _dwCallbackReason: c::DWORD,
 621         _hSourceFile: c::HANDLE,
 622         _hDestinationFile: c::HANDLE,
 623         lpData: c::LPVOID,
 624     ) -> c::DWORD {
 625         *(lpData as *mut i64) = TotalBytesTransferred;
 626         c::PROGRESS_CONTINUE
 627     }
 628     let pfrom = try!(to_u16s(from));
 629     let pto = try!(to_u16s(to));
 630     let mut size = 0i64;
 631     try!(cvt(unsafe {
 632         c::CopyFileExW(pfrom.as_ptr(), pto.as_ptr(), Some(callback),
 633                        &mut size as *mut _ as *mut _, ptr::null_mut(), 0)
 634     }));
 635     Ok(size as u64)
 636 }
 637
 638 #[test]
 639 fn directory_junctions_are_directories() {
 640     use ffi::OsStr;
 641     use env;
 642     use rand::{self, Rng};
 643     use vec::Vec;
 644
 645     macro_rules! t {
 646         ($e:expr) => (match $e {
 647             Ok(e) => e,
 648             Err(e) => panic!("{} failed with: {}", stringify!($e), e),
 649         })
 650     }
 651
 652     let d = DirBuilder::new();
 653     let p = env::temp_dir();
 654     let mut r = rand::thread_rng();
 655     let ret = p.join(&format!("rust-{}", r.next_u32()));
 656     let foo = ret.join("foo");
 657     let bar = ret.join("bar");
 658     t!(d.mkdir(&ret));
 659     t!(d.mkdir(&foo));
 660     t!(d.mkdir(&bar));
 661
 662     t!(create_junction(&bar, &foo));
 663     let metadata = stat(&bar);
 664     t!(delete_junction(&bar));
 665
 666     t!(rmdir(&foo));
 667     t!(rmdir(&bar));
 668     t!(rmdir(&ret));
 669
 670     let metadata = t!(metadata);
 671     assert!(metadata.file_type().is_dir());
 672
 673     // Creating a directory junction on windows involves dealing with reparse
 674     // points and the DeviceIoControl function, and this code is a skeleton of
 675     // what can be found here:
 676     //
 677     // http://www.flexhex.com/docs/articles/hard-links.phtml
 678     fn create_junction(src: &Path, dst: &Path) -> io::Result<()> {
 679         let f = try!(opendir(src, true));
 680         let h = f.handle().raw();
 681
 682         unsafe {
 683             let mut data = [0u8; c::MAXIMUM_REPARSE_DATA_BUFFER_SIZE];
 684             let mut db = data.as_mut_ptr()
 685                             as *mut c::REPARSE_MOUNTPOINT_DATA_BUFFER;
 686             let buf = &mut (*db).ReparseTarget as *mut _;
 687             let mut i = 0;
 688             let v = br"\??\";
 689             let v = v.iter().map(|x| *x as u16);
 690             for c in v.chain(dst.as_os_str().encode_wide()) {
 691                 *buf.offset(i) = c;
 692                 i += 1;
 693             }
 694             *buf.offset(i) = 0;
 695             i += 1;
 696             (*db).ReparseTag = c::IO_REPARSE_TAG_MOUNT_POINT;
 697             (*db).ReparseTargetMaximumLength = (i * 2) as c::WORD;
 698             (*db).ReparseTargetLength = ((i - 1) * 2) as c::WORD;
 699             (*db).ReparseDataLength =
 700                     (*db).ReparseTargetLength as c::DWORD + 12;
 701
 702             let mut ret = 0;
 703             cvt(c::DeviceIoControl(h as *mut _,
 704                                    c::FSCTL_SET_REPARSE_POINT,
 705                                    data.as_ptr() as *mut _,
 706                                    (*db).ReparseDataLength + 8,
 707                                    ptr::null_mut(), 0,
 708                                    &mut ret,
 709                                    ptr::null_mut())).map(|_| ())
 710         }
 711     }
 712
 713     fn opendir(p: &Path, write: bool) -> io::Result<File> {
 714         unsafe {
 715             let mut token = ptr::null_mut();
 716             let mut tp: c::TOKEN_PRIVILEGES = mem::zeroed();
 717             try!(cvt(c::OpenProcessToken(c::GetCurrentProcess(),
 718                                          c::TOKEN_ADJUST_PRIVILEGES,
 719                                          &mut token)));
 720             let name: &OsStr = if write {
 721                 "SeRestorePrivilege".as_ref()
 722             } else {
 723                 "SeBackupPrivilege".as_ref()
 724             };
 725             let name = name.encode_wide().chain(Some(0)).collect::<Vec<_>>();
 726             try!(cvt(c::LookupPrivilegeValueW(ptr::null(),
 727                                               name.as_ptr(),
 728                                               &mut tp.Privileges[0].Luid)));
 729             tp.PrivilegeCount = 1;
 730             tp.Privileges[0].Attributes = c::SE_PRIVILEGE_ENABLED;
 731             let size = mem::size_of::<c::TOKEN_PRIVILEGES>() as c::DWORD;
 732             try!(cvt(c::AdjustTokenPrivileges(token, c::FALSE, &mut tp, size,
 733                                               ptr::null_mut(), ptr::null_mut())));
 734             try!(cvt(c::CloseHandle(token)));
 735
 736             File::open_reparse_point(p, write)
 737         }
 738     }
 739
 740     fn delete_junction(p: &Path) -> io::Result<()> {
 741         unsafe {
 742             let f = try!(opendir(p, true));
 743             let h = f.handle().raw();
 744             let mut data = [0u8; c::MAXIMUM_REPARSE_DATA_BUFFER_SIZE];
 745             let mut db = data.as_mut_ptr()
 746                             as *mut c::REPARSE_MOUNTPOINT_DATA_BUFFER;
 747             (*db).ReparseTag = c::IO_REPARSE_TAG_MOUNT_POINT;
 748             let mut bytes = 0;
 749             cvt(c::DeviceIoControl(h as *mut _,
 750                                    c::FSCTL_DELETE_REPARSE_POINT,
 751                                    data.as_ptr() as *mut _,
 752                                    (*db).ReparseDataLength + 8,
 753                                    ptr::null_mut(), 0,
 754                                    &mut bytes,
 755                                    ptr::null_mut())).map(|_| ())
 756         }
 757     }
 758 }