Merge pull request #2244 from rbtcollins/fallback-settings

fallback-settings file

Author: kinnison

Cargo.lock

@@ -42,6 +42,7 @@ remove_dir_all = "0.5.1"
 same-file = "1"
 scopeguard = "1"
 semver = "0.9"
+serde = { version = "1.0", features = ["derive"] }
 sha2 = "0.8"
 strsim = "0.9.1"
 tar = "0.4.26"

Cargo.toml

@@ -31,6 +31,7 @@ And it runs on all platforms Rust supports, including Windows.
 * [Working with custom toolchains](#working-with-custom-toolchains-and-local-builds)
 * [Working with network proxies](#working-with-network-proxies)
 * [Examples](#examples)
+* [Configuration files](#configuration-files)
 * [Environment variables](#environment-variables)
 * [Other installation methods](#other-installation-methods)
 * [Security](#security)
@@ -639,6 +640,17 @@ Command                                                     | Description
 `rustup toolchain help`                                     | Show the `help` page for a subcommand (like `toolchain`)
 `rustup man cargo`                                          | \(*Unix only*\) View the man page for a given command (like `cargo`)
 
+## Configuration files
+
+Rustup has a settings file in [TOML](https://github.com/toml-lang/toml) format
+at `${RUSTUP_HOME}/settings.toml`. The schema for this file is not part of the
+public interface for rustup - the rustup CLI should be used to query and set
+settings.
+
+On Unix operating systems a fallback settings file is consulted for some
+settings. This fallback file is located at `/etc/rustup/settings.toml` and
+currently can define only `default_toolchain`.
+
 ## Environment variables
 
 

README.md

@@ -11,6 +11,7 @@ use pgp::{Deserializable, SignedPublicKey};
 
 use crate::dist::{dist, temp};
 use crate::errors::*;
+use crate::fallback_settings::FallbackSettings;
 use crate::notifications::*;
 use crate::settings::{Settings, SettingsFile, DEFAULT_METADATA_VERSION};
 use crate::toolchain::{Toolchain, UpdateStatus};
@@ -108,10 +109,13 @@ impl Display for PgpPublicKey {
     }
 }
 
+pub const UNIX_FALLBACK_SETTINGS: &str = "/etc/rustup/settings.toml";
+
 pub struct Cfg {
     pub profile_override: Option<dist::Profile>,
     pub rustup_dir: PathBuf,
     pub settings_file: SettingsFile,
+    pub fallback_settings: Option<FallbackSettings>,
     pub toolchains_dir: PathBuf,
     pub update_hash_dir: PathBuf,
     pub download_dir: PathBuf,
@@ -133,6 +137,13 @@ impl Cfg {
 
         let settings_file = SettingsFile::new(rustup_dir.join("settings.toml"));
 
+        // Centralised file for multi-user systems to provide admin/distributor set initial values.
+        let fallback_settings = if cfg!(not(windows)) {
+            FallbackSettings::new(PathBuf::from(UNIX_FALLBACK_SETTINGS))?
+        } else {
+            None
+        };
+
         let toolchains_dir = rustup_dir.join("toolchains");
         let update_hash_dir = rustup_dir.join("update-hashes");
         let download_dir = rustup_dir.join("downloads");
@@ -191,6 +202,7 @@ impl Cfg {
             profile_override: None,
             rustup_dir,
             settings_file,
+            fallback_settings,
             toolchains_dir,
             update_hash_dir,
             download_dir,
@@ -362,9 +374,7 @@ impl Cfg {
     }
 
     pub fn find_default(&self) -> Result<Option<Toolchain<'_>>> {
-        let opt_name = self
-            .settings_file
-            .with(|s| Ok(s.default_toolchain.clone()))?;
+        let opt_name = self.get_default()?;
 
         if let Some(name) = opt_name {
             let toolchain = Toolchain::from(self, &name)?;
@@ -510,7 +520,14 @@ impl Cfg {
     }
 
     pub fn get_default(&self) -> Result<Option<String>> {
-        self.settings_file.with(|s| Ok(s.default_toolchain.clone()))
+        let user_opt = self.settings_file.with(|s| Ok(s.default_toolchain.clone()));
+        if let Some(fallback_settings) = &self.fallback_settings {
+            match user_opt {
+                Err(_) | Ok(None) => return Ok(fallback_settings.default_toolchain.clone()),
+                _ => {}
+            };
+        };
+        user_opt
     }
 
     pub fn list_toolchains(&self) -> Result<Vec<String>> {

src/config.rs

@@ -347,6 +347,9 @@ error_chain! {
             display("component {} was automatically added because it is required for toolchain '{}'",
                     c, t)
         }
+        ParsingFallbackSettings(e: toml::de::Error) {
+            description("error parsing settings")
+        }
         ParsingSettings(e: toml::de::Error) {
             description("error parsing settings")
         }

src/errors.rs

@@ -0,0 +1,41 @@
+use crate::errors::*;
+use crate::utils::utils;
+use serde::Deserialize;
+use std::error::Error;
+use std::io;
+use std::path::Path;
+
+#[derive(Clone, Debug, Deserialize, PartialEq)]
+pub struct FallbackSettings {
+    pub default_toolchain: Option<String>,
+}
+
+impl Default for FallbackSettings {
+    fn default() -> Self {
+        Self {
+            default_toolchain: None,
+        }
+    }
+}
+
+impl FallbackSettings {
+    pub fn new<P: AsRef<Path>>(path: P) -> Result<Option<Self>> {
+        // Users cannot fix issues with missing/unreadable/invalid centralised files, but logging isn't setup early so
+        // we can't simply trap all errors and log diagnostics. Ideally we would, and then separate these into different
+        // sorts of issues, logging messages about errors that should be fixed. Instead we trap some conservative errors
+        // that hopefully won't lead to too many tickets.
+        match utils::read_file("fallback settings", path.as_ref()) {
+            Err(e @ Error(ErrorKind::ReadingFile { .. }, _)) => {
+                let io_err = e.source().unwrap().downcast_ref::<io::Error>().unwrap();
+                match io_err.kind() {
+                    io::ErrorKind::NotFound | io::ErrorKind::PermissionDenied => Ok(None),
+                    _ => Err(e.into()),
+                }
+            }
+            Err(e) => Err(e),
+            Ok(file_contents) => Ok(Some(
+                toml::from_str(&file_contents).map_err(ErrorKind::ParsingFallbackSettings)?,
+            )),
+        }
+    }
+}

src/fallback_settings.rs

@@ -58,6 +58,7 @@ pub mod diskio;
 pub mod dist;
 pub mod env_var;
 pub mod errors;
+pub mod fallback_settings;
 mod install;
 mod notifications;
 pub mod settings;