1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
// Copyright 2013 The Rust Project Developers. See the COPYRIGHT // file at the top-level directory of this distribution and at // http://rust-lang.org/COPYRIGHT. // // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your // option. This file may not be copied, modified, or distributed // except according to those terms. //! Temporary files and directories #![allow(deprecated)] // rand use env; use iter::{IteratorExt}; use old_io::{fs, IoError, IoErrorKind, IoResult}; use old_io; use ops::Drop; use option::Option::{None, Some}; use option::Option; use old_path::{Path, GenericPath}; use rand::{Rng, thread_rng}; use result::Result::{Ok, Err}; use str::StrExt; use string::String; /// A wrapper for a path to temporary directory implementing automatic /// scope-based deletion. /// /// # Examples /// /// ```no_run /// use std::old_io::TempDir; /// /// { /// // create a temporary directory /// let tmpdir = match TempDir::new("myprefix") { /// Ok(dir) => dir, /// Err(e) => panic!("couldn't create temporary directory: {}", e) /// }; /// /// // get the path of the temporary directory without affecting the wrapper /// let tmppath = tmpdir.path(); /// /// println!("The path of temporary directory is {}", tmppath.display()); /// /// // the temporary directory is automatically removed when tmpdir goes /// // out of scope at the end of the block /// } /// { /// // create a temporary directory, this time using a custom path /// let tmpdir = match TempDir::new_in(&Path::new("/tmp/best/custom/path"), "myprefix") { /// Ok(dir) => dir, /// Err(e) => panic!("couldn't create temporary directory: {}", e) /// }; /// /// // get the path of the temporary directory and disable automatic deletion in the wrapper /// let tmppath = tmpdir.into_inner(); /// /// println!("The path of the not-so-temporary directory is {}", tmppath.display()); /// /// // the temporary directory is not removed here /// // because the directory is detached from the wrapper /// } /// { /// // create a temporary directory /// let tmpdir = match TempDir::new("myprefix") { /// Ok(dir) => dir, /// Err(e) => panic!("couldn't create temporary directory: {}", e) /// }; /// /// // close the temporary directory manually and check the result /// match tmpdir.close() { /// Ok(_) => println!("success!"), /// Err(e) => panic!("couldn't remove temporary directory: {}", e) /// }; /// } /// ``` pub struct TempDir { path: Option<Path>, disarmed: bool } // How many times should we (re)try finding an unused random name? It should be // enough that an attacker will run out of luck before we run out of patience. const NUM_RETRIES: u32 = 1 << 31; // How many characters should we include in a random file name? It needs to // be enough to dissuade an attacker from trying to preemptively create names // of that length, but not so huge that we unnecessarily drain the random number // generator of entropy. const NUM_RAND_CHARS: uint = 12; impl TempDir { /// Attempts to make a temporary directory inside of `tmpdir` whose name /// will have the prefix `prefix`. The directory will be automatically /// deleted once the returned wrapper is destroyed. /// /// If no directory can be created, `Err` is returned. pub fn new_in(tmpdir: &Path, prefix: &str) -> IoResult<TempDir> { if !tmpdir.is_absolute() { let cur_dir = try!(env::current_dir()); return TempDir::new_in(&cur_dir.join(tmpdir), prefix); } let mut rng = thread_rng(); for _ in 0..NUM_RETRIES { let suffix: String = rng.gen_ascii_chars().take(NUM_RAND_CHARS).collect(); let leaf = if prefix.len() > 0 { format!("{}.{}", prefix, suffix) } else { // If we're given an empty string for a prefix, then creating a // directory starting with "." would lead to it being // semi-invisible on some systems. suffix }; let path = tmpdir.join(leaf); match fs::mkdir(&path, old_io::USER_RWX) { Ok(_) => return Ok(TempDir { path: Some(path), disarmed: false }), Err(IoError{kind:IoErrorKind::PathAlreadyExists,..}) => (), Err(e) => return Err(e) } } return Err(IoError{ kind: IoErrorKind::PathAlreadyExists, desc:"Exhausted", detail: None}); } /// Attempts to make a temporary directory inside of `os::tmpdir()` whose /// name will have the prefix `prefix`. The directory will be automatically /// deleted once the returned wrapper is destroyed. /// /// If no directory can be created, `Err` is returned. pub fn new(prefix: &str) -> IoResult<TempDir> { TempDir::new_in(&env::temp_dir(), prefix) } /// Unwrap the wrapped `std::path::Path` from the `TempDir` wrapper. /// This discards the wrapper so that the automatic deletion of the /// temporary directory is prevented. pub fn into_inner(self) -> Path { let mut tmpdir = self; tmpdir.path.take().unwrap() } /// Access the wrapped `std::path::Path` to the temporary directory. pub fn path<'a>(&'a self) -> &'a Path { self.path.as_ref().unwrap() } /// Close and remove the temporary directory /// /// Although `TempDir` removes the directory on drop, in the destructor /// any errors are ignored. To detect errors cleaning up the temporary /// directory, call `close` instead. pub fn close(mut self) -> IoResult<()> { self.cleanup_dir() } fn cleanup_dir(&mut self) -> IoResult<()> { assert!(!self.disarmed); self.disarmed = true; match self.path { Some(ref p) => { fs::rmdir_recursive(p) } None => Ok(()) } } } impl Drop for TempDir { fn drop(&mut self) { if !self.disarmed { let _ = self.cleanup_dir(); } } } // the tests for this module need to change the path using change_dir, // and this doesn't play nicely with other tests so these unit tests are located // in src/test/run-pass/tempfile.rs