      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247

    // Copyright 2015-2017 Parity Technologies (UK) Ltd.
    // This file is part of Parity.

    // Parity is free software: you can redistribute it and/or modify
    // it under the terms of the GNU General Public License as published by
    // the Free Software Foundation, either version 3 of the License, or
    // (at your option) any later version.

    // Parity is distributed in the hope that it will be useful,
    // but WITHOUT ANY WARRANTY; without even the implied warranty of
    // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    // GNU General Public License for more details.

    // You should have received a copy of the GNU General Public License
    // along with Parity.  If not, see <http://www.gnu.org/licenses/>.

    use std::fs;
    use std::path::{PathBuf, Path};
    use util::{H64, H256};
    use util::journaldb::Algorithm;
    use helpers::{replace_home, replace_home_for_db};
    use app_dirs::{AppInfo, get_app_root, AppDataType};

    #[cfg(target_os = "macos")] const AUTHOR: &'static str = "Parity";
    #[cfg(target_os = "macos")] const PRODUCT: &'static str = "io.parity.ethereum";
    #[cfg(target_os = "macos")] const PRODUCT_HYPERVISOR: &'static str = "io.parity.ethereum-updates";
    #[cfg(target_os = "windows")] const AUTHOR: &'static str = "Parity";
    #[cfg(target_os = "windows")] const PRODUCT: &'static str = "Ethereum";
    #[cfg(target_os = "windows")] const PRODUCT_HYPERVISOR: &'static str = "EthereumUpdates";
    #[cfg(not(any(target_os = "windows", target_os = "macos")))] const AUTHOR: &'static str = "parity";
    #[cfg(not(any(target_os = "windows", target_os = "macos")))] const PRODUCT: &'static str = "io.parity.ethereum";
    #[cfg(not(any(target_os = "windows", target_os = "macos")))] const PRODUCT_HYPERVISOR: &'static str = "io.parity.ethereum-updates";

    #[cfg(target_os = "windows")] pub const CHAINS_PATH: &'static str = "$LOCAL/chains";
    #[cfg(not(target_os = "windows"))] pub const CHAINS_PATH: &'static str = "$BASE/chains";

    // this const is irrelevent cause we do have migrations now,
    // but we still use it for backwards compatibility
    const LEGACY_CLIENT_DB_VER_STR: &'static str = "5.3";

    #[derive(Debug, PartialEq)]
    pub struct Directories {
    	pub base: String,
    	pub db: String,
    	pub keys: String,
    	pub signer: String,
    	pub dapps: String,
    }

    impl Default for Directories {
    	fn default() -> Self {
    		let data_dir = default_data_path();
    		let local_dir = default_local_path();
    		Directories {
    			base: replace_home(&data_dir, "$BASE"),
    			db: replace_home_for_db(&data_dir, &local_dir, CHAINS_PATH),
    			keys: replace_home(&data_dir, "$BASE/keys"),
    			signer: replace_home(&data_dir, "$BASE/signer"),
    			dapps: replace_home(&data_dir, "$BASE/dapps"),
    		}
    	}
    }

    impl Directories {
    	pub fn create_dirs(&self, dapps_enabled: bool, signer_enabled: bool) -> Result<(), String> {
    		fs::create_dir_all(&self.base).map_err(|e| e.to_string())?;
    		fs::create_dir_all(&self.db).map_err(|e| e.to_string())?;
    		fs::create_dir_all(&self.keys).map_err(|e| e.to_string())?;
    		if signer_enabled {
    			fs::create_dir_all(&self.signer).map_err(|e| e.to_string())?;
    		}
    		if dapps_enabled {
    			fs::create_dir_all(&self.dapps).map_err(|e| e.to_string())?;
    		}
    		Ok(())
    	}

    	/// Database paths.
    	pub fn database(&self, genesis_hash: H256, fork_name: Option<String>, spec_name: String) -> DatabaseDirectories {
    		DatabaseDirectories {
    			path: self.db.clone(),
    			legacy_path: self.base.clone(),
    			genesis_hash: genesis_hash,
    			fork_name: fork_name,
    			spec_name: spec_name,
    		}
    	}

    	/// Get the ipc sockets path
    	pub fn ipc_path(&self) -> PathBuf {
    		let mut dir = Path::new(&self.base).to_path_buf();
    		dir.push("ipc");
    		dir
    	}

    	// TODO: remove in 1.7
    	pub fn legacy_keys_path(&self, testnet: bool) -> PathBuf {
    		let mut dir = Path::new(&self.base).to_path_buf();
    		if testnet {
    			dir.push("testnet_keys");
    		} else {
    			dir.push("keys");
    		}
    		dir
    	}

    	pub fn keys_path(&self, spec_name: &str) -> PathBuf {
    		let mut dir = PathBuf::from(&self.keys);
    		dir.push(spec_name);
    		dir
    	}
    }

    #[derive(Debug, PartialEq)]
    pub struct DatabaseDirectories {
    	pub path: String,
    	pub legacy_path: String,
    	pub genesis_hash: H256,
    	pub fork_name: Option<String>,
    	pub spec_name: String,
    }

    impl DatabaseDirectories {
    	/// Base DB directory for the given fork.
    	// TODO: remove in 1.7
    	pub fn legacy_fork_path(&self) -> PathBuf {
    		let mut dir = Path::new(&self.legacy_path).to_path_buf();
    		dir.push(format!("{:?}{}", H64::from(self.genesis_hash), self.fork_name.as_ref().map(|f| format!("-{}", f)).unwrap_or_default()));
    		dir
    	}

    	pub fn spec_root_path(&self) -> PathBuf {
    		let mut dir = Path::new(&self.path).to_path_buf();
    		dir.push(&self.spec_name);
    		dir
    	}

    	pub fn client_path(&self, pruning: Algorithm) -> PathBuf {
    		let mut dir = self.db_root_path();
    		dir.push(pruning.as_internal_name_str());
    		dir.push("db");
    		dir
    	}

    	pub fn db_root_path(&self) -> PathBuf {
    		let mut dir = self.spec_root_path();
    		dir.push("db");
    		dir.push(H64::from(self.genesis_hash).hex());
    		dir
    	}

    	pub fn db_path(&self, pruning: Algorithm) -> PathBuf {
    		let mut dir = self.db_root_path();
    		dir.push(pruning.as_internal_name_str());
    		dir
    	}

    	/// Get the root path for database
    	// TODO: remove in 1.7
    	pub fn legacy_version_path(&self, pruning: Algorithm) -> PathBuf {
    		let mut dir = self.legacy_fork_path();
    		dir.push(format!("v{}-sec-{}", LEGACY_CLIENT_DB_VER_STR, pruning.as_internal_name_str()));
    		dir
    	}

    	/// Get user defaults path
    	// TODO: remove in 1.7
    	pub fn legacy_user_defaults_path(&self) -> PathBuf {
    		let mut dir = self.legacy_fork_path();
    		dir.push("user_defaults");
    		dir
    	}

    	/// Get user defaults path
    	// TODO: remove in 1.7
    	pub fn legacy_snapshot_path(&self) -> PathBuf {
    		let mut dir = self.legacy_fork_path();
    		dir.push("snapshot");
    		dir
    	}

    	/// Get user defaults path
    	// TODO: remove in 1.7
    	pub fn legacy_network_path(&self) -> PathBuf {
    		let mut dir = self.legacy_fork_path();
    		dir.push("network");
    		dir
    	}

    	pub fn user_defaults_path(&self) -> PathBuf {
    		let mut dir = self.spec_root_path();
    		dir.push("user_defaults");
    		dir
    	}

    	/// Get the path for the snapshot directory given the genesis hash and fork name.
    	pub fn snapshot_path(&self) -> PathBuf {
    		let mut dir = self.db_root_path();
    		dir.push("snapshot");
    		dir
    	}

    	/// Get the path for the network directory.
    	pub fn network_path(&self) -> PathBuf {
    		let mut dir = self.spec_root_path();
    		dir.push("network");
    		dir
    	}
    }

    pub fn default_data_path() -> String {
    	let app_info = AppInfo { name: PRODUCT, author: AUTHOR };
    	get_app_root(AppDataType::UserData, &app_info).map(|p| p.to_string_lossy().into_owned()).unwrap_or_else(|_| "$HOME/.parity".to_owned())
    }

    pub fn default_local_path() -> String {
    	let app_info = AppInfo { name: PRODUCT, author: AUTHOR };
    	get_app_root(AppDataType::UserCache, &app_info).map(|p| p.to_string_lossy().into_owned()).unwrap_or_else(|_| "$HOME/.parity".to_owned())
    }

    pub fn default_hypervisor_path() -> String {
    	let app_info = AppInfo { name: PRODUCT_HYPERVISOR, author: AUTHOR };
    	get_app_root(AppDataType::UserData, &app_info).map(|p| p.to_string_lossy().into_owned()).unwrap_or_else(|_| "$HOME/.parity-hypervisor".to_owned())
    }

    #[cfg(test)]
    mod tests {
    	use super::Directories;
    	use helpers::{replace_home, replace_home_for_db};

    	#[test]
    	fn test_default_directories() {
    		let data_dir = super::default_data_path();
    		let local_dir = super::default_local_path();
    		let expected = Directories {
    			base: replace_home(&data_dir, "$BASE"),
    			db: replace_home_for_db(&data_dir, &local_dir,
    				if cfg!(target_os = "windows") { "$LOCAL/chains" }
    				else { "$BASE/chains" }
    			),
    			keys: replace_home(&data_dir, "$BASE/keys"),
    			signer: replace_home(&data_dir, "$BASE/signer"),
    			dapps: replace_home(&data_dir, "$BASE/dapps"),
    		};
    		assert_eq!(expected, Directories::default());
    	}
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)