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 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
|
use crate::dependency::Dependency;
use crate::session::Session;
#[derive(Debug)]
/// Errors that can occur during dependency installation.
pub enum Error {
/// Error indicating that the dependency family is unknown.
UnknownDependencyFamily,
/// Error indicating that the requested installation scope is not supported.
UnsupportedScope(InstallationScope),
/// Error indicating that the requested installation scopes are not supported.
UnsupportedScopes(Vec<InstallationScope>),
/// Error from analyzing a command execution.
AnalyzedError(crate::analyze::AnalyzedError),
/// Error from the session.
SessionError(crate::session::Error),
/// Other error with a message.
Other(String),
}
impl std::fmt::Display for Error {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
match self {
Error::UnknownDependencyFamily => write!(f, "Unknown dependency family"),
Error::UnsupportedScope(scope) => write!(f, "Unsupported scope: {:?}", scope),
Error::UnsupportedScopes(scopes) => write!(f, "Unsupported scopes: {:?}", scopes),
Error::AnalyzedError(e) => write!(f, "{}", e),
Error::SessionError(e) => write!(f, "{}", e),
Error::Other(s) => write!(f, "{}", s),
}
}
}
impl std::error::Error for Error {}
impl From<crate::analyze::AnalyzedError> for Error {
fn from(e: crate::analyze::AnalyzedError) -> Self {
Error::AnalyzedError(e)
}
}
impl From<crate::session::Error> for Error {
fn from(e: crate::session::Error) -> Self {
Error::SessionError(e)
}
}
/// An explanation is a human-readable description of what to do to install a dependency.
pub struct Explanation {
/// A human-readable message explaining how to install the dependency.
pub message: String,
/// An optional command that can be run to install the dependency.
pub command: Option<Vec<String>>,
}
impl Explanation {
/// Create a new explanation.
///
/// # Arguments
/// * `message` - A human-readable message explaining how to install the dependency
/// * `command` - An optional command that can be run to install the dependency
///
/// # Returns
/// A new Explanation instance
pub fn new(message: String, command: Option<Vec<String>>) -> Self {
Explanation { message, command }
}
}
impl std::fmt::Display for Explanation {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(f, "{}", self.message)?;
if let Some(command) = &self.command {
write!(
f,
"\n\nRun the following command to install the dependency:\n\n"
)?;
for arg in command {
write!(f, "{} ", arg)?;
}
writeln!(f)?;
}
Ok(())
}
}
/// The scope of an installation.
#[derive(Debug, Clone, PartialEq, Eq, Copy)]
pub enum InstallationScope {
/// Under /usr in the system
Global,
/// In the current users' home directory
User,
/// Vendored in the projects' source directory
Vendor,
}
impl std::str::FromStr for InstallationScope {
type Err = Error;
fn from_str(s: &str) -> Result<Self, Self::Err> {
match s {
"global" => Ok(InstallationScope::Global),
"user" => Ok(InstallationScope::User),
"vendor" => Ok(InstallationScope::Vendor),
_ => Err(Error::Other(format!("Unknown installation scope: {}", s))),
}
}
}
/// An installer can take a dependency and install it into the session.
pub trait Installer {
/// Install the dependency into the session.
fn install(&self, dep: &dyn Dependency, scope: InstallationScope) -> Result<(), Error>;
/// Explain how to install the dependency.
fn explain(&self, dep: &dyn Dependency, scope: InstallationScope)
-> Result<Explanation, Error>;
/// Explain how to install multiple dependencies.
///
/// # Arguments
/// * `deps` - List of dependencies to explain
/// * `scope` - Installation scope to use
///
/// # Returns
/// * `Ok((Vec<Explanation>, Vec<Box<dyn Dependency>>))` - Explanations for known dependencies and list of unknown dependencies
/// * `Err(Error)` - If explaining any dependency fails with an error other than UnknownDependencyFamily
fn explain_some(
&self,
deps: Vec<Box<dyn Dependency>>,
scope: InstallationScope,
) -> Result<(Vec<Explanation>, Vec<Box<dyn Dependency>>), Error> {
let mut explanations = Vec::new();
let mut failed = Vec::new();
for dep in deps {
match self.explain(&*dep, scope) {
Ok(explanation) => explanations.push(explanation),
Err(Error::UnknownDependencyFamily) => failed.push(dep),
Err(e) => {
return Err(e);
}
}
}
Ok((explanations, failed))
}
/// Install multiple dependencies.
///
/// # Arguments
/// * `deps` - List of dependencies to install
/// * `scope` - Installation scope to use
///
/// # Returns
/// * `Ok((Vec<Box<dyn Dependency>>, Vec<Box<dyn Dependency>>))` - Successfully installed dependencies and unknown dependencies
/// * `Err(Error)` - If installing any dependency fails with an error other than UnknownDependencyFamily
fn install_some(
&self,
deps: Vec<Box<dyn Dependency>>,
scope: InstallationScope,
) -> Result<(Vec<Box<dyn Dependency>>, Vec<Box<dyn Dependency>>), Error> {
let mut installed = Vec::new();
let mut failed = Vec::new();
for dep in deps {
match self.install(&*dep, scope) {
Ok(()) => installed.push(dep),
Err(Error::UnknownDependencyFamily) => failed.push(dep),
Err(e) => {
return Err(e);
}
}
}
Ok((installed, failed))
}
}
/// A null installer does nothing.
pub struct NullInstaller;
impl NullInstaller {
/// Create a new NullInstaller.
///
/// # Returns
/// A new NullInstaller instance
pub fn new() -> Self {
NullInstaller
}
}
impl Default for NullInstaller {
fn default() -> Self {
NullInstaller::new()
}
}
impl Installer for NullInstaller {
fn install(&self, _dep: &dyn Dependency, _scope: InstallationScope) -> Result<(), Error> {
Err(Error::UnknownDependencyFamily)
}
fn explain(
&self,
_dep: &dyn Dependency,
_scope: InstallationScope,
) -> Result<Explanation, Error> {
Err(Error::UnknownDependencyFamily)
}
}
/// An installer that tries multiple installers in sequence.
///
/// This installer tries each installer in order until one succeeds or all fail.
pub struct StackedInstaller<'a>(pub Vec<Box<dyn Installer + 'a>>);
impl<'a> StackedInstaller<'a> {
/// Create a new StackedInstaller.
///
/// # Arguments
/// * `resolvers` - List of installers to try in sequence
///
/// # Returns
/// A new StackedInstaller instance
pub fn new(resolvers: Vec<Box<dyn Installer + 'a>>) -> Self {
Self(resolvers)
}
}
impl<'a> Installer for StackedInstaller<'a> {
fn install(&self, requirement: &dyn Dependency, scope: InstallationScope) -> Result<(), Error> {
for sub in &self.0 {
match sub.install(requirement, scope) {
Ok(()) => {
return Ok(());
}
Err(Error::UnknownDependencyFamily) => {}
Err(e) => {
return Err(e);
}
}
}
Err(Error::UnknownDependencyFamily)
}
fn explain(
&self,
requirements: &dyn Dependency,
scope: InstallationScope,
) -> Result<Explanation, Error> {
for sub in &self.0 {
match sub.explain(requirements, scope) {
Ok(e) => {
return Ok(e);
}
Err(Error::UnknownDependencyFamily) => {}
Err(e) => {
return Err(e);
}
}
}
Err(Error::UnknownDependencyFamily)
}
}
/// Create an installer by name.
///
/// # Arguments
/// * `session` - The session to use for installation
/// * `name` - The name of the installer to create
///
/// # Returns
/// An installer that can install dependencies in the given session
pub fn installer_by_name<'a>(
session: &'a dyn crate::session::Session,
name: &str,
) -> Option<Box<dyn Installer + 'a>> {
// TODO: Use more dynamic way to load installers
match name {
#[cfg(feature = "debian")]
"apt" => Some(
Box::new(crate::debian::apt::AptInstaller::from_session(session)) as Box<dyn Installer>,
),
"cpan" => Some(
Box::new(crate::dependencies::perl::CPAN::new(session, false)) as Box<dyn Installer>,
),
"ctan" => Some(Box::new(crate::dependencies::latex::ctan(session)) as Box<dyn Installer>),
"pypi" => Some(
Box::new(crate::dependencies::python::PypiResolver::new(session)) as Box<dyn Installer>,
),
"npm" => Some(
Box::new(crate::dependencies::node::NpmResolver::new(session)) as Box<dyn Installer>,
),
"go" => {
Some(Box::new(crate::dependencies::go::GoResolver::new(session)) as Box<dyn Installer>)
}
"hackage" => Some(
Box::new(crate::dependencies::haskell::HackageResolver::new(session))
as Box<dyn Installer>,
),
"cran" => Some(Box::new(crate::dependencies::r::cran(session)) as Box<dyn Installer>),
"bioconductor" => {
Some(Box::new(crate::dependencies::r::bioconductor(session)) as Box<dyn Installer>)
}
"octave-forge" => Some(
Box::new(crate::dependencies::octave::OctaveForgeResolver::new(
session,
)) as Box<dyn Installer>,
),
"native" => {
Some(Box::new(StackedInstaller::new(native_installers(session))) as Box<dyn Installer>)
}
_ => None,
}
}
/// Create a list of all native installers for the current system.
///
/// # Arguments
/// * `session` - The session to use for installation
///
/// # Returns
/// A list of installers that can install dependencies on the current system
pub fn native_installers<'a>(
session: &'a dyn crate::session::Session,
) -> Vec<Box<dyn Installer + 'a>> {
// TODO: Use more dynamic way to load installers
[
"ctan",
"pypi",
"npm",
"go",
"hackage",
"cran",
"bioconductor",
"octave-forge",
]
.iter()
.map(|name| installer_by_name(session, name).unwrap())
.collect()
}
#[cfg(feature = "debian")]
fn apt_installer<'a>(
session: &'a dyn crate::session::Session,
#[allow(unused_variables)] dep_server_url: Option<&url::Url>,
) -> Box<dyn Installer + 'a> {
#[cfg(feature = "dep-server")]
if let Some(dep_server_url) = dep_server_url {
Box::new(
crate::debian::dep_server::DepServerAptInstaller::from_session(session, dep_server_url),
) as Box<dyn Installer + 'a>
} else {
Box::new(crate::debian::apt::AptInstaller::from_session(session))
}
#[cfg(not(feature = "dep-server"))]
{
Box::new(crate::debian::apt::AptInstaller::from_session(session))
}
}
/// Select installers by name.
pub fn select_installers<'a>(
session: &'a dyn crate::session::Session,
names: &[&str],
#[allow(unused_variables)] dep_server_url: Option<&url::Url>,
) -> Result<Box<dyn Installer + 'a>, String> {
let mut installers = Vec::new();
for name in names.iter() {
if name == &"apt" {
#[cfg(feature = "debian")]
installers.push(apt_installer(session, dep_server_url));
#[cfg(not(feature = "debian"))]
return Err("Apt installer not available".to_string());
} else if let Some(installer) = installer_by_name(session, name) {
installers.push(installer);
} else {
return Err(format!("Unknown installer: {}", name));
}
}
Ok(Box::new(StackedInstaller(installers)))
}
/// Determine the default installation scope based on the session.
///
/// # Arguments
/// * `session` - The session to determine the scope for
///
/// # Returns
/// The default installation scope for the session
pub fn auto_installation_scope(session: &dyn crate::session::Session) -> InstallationScope {
let user = crate::session::get_user(session);
// TODO(jelmer): Check VIRTUAL_ENV, and prioritize PypiResolver if
// present?
if user == "root" {
log::info!("Running as root, so using global installation scope");
InstallationScope::Global
} else if session.is_temporary() {
log::info!("Running in a temporary session, so using global installation scope");
InstallationScope::Global
} else {
log::info!("Running as user, so using user installation scope");
InstallationScope::User
}
}
/// Create an automatic installer that can install dependencies in the given session.
///
/// # Arguments
/// * `session` - The session to use for installation
/// * `scope` - The installation scope to use
/// * `dep_server_url` - Optional URL of a dependency server to use
///
/// # Returns
/// An installer that can install dependencies in the given session
pub fn auto_installer<'a>(
session: &'a dyn crate::session::Session,
#[allow(unused_variables)] scope: InstallationScope,
#[allow(unused_variables)] dep_server_url: Option<&url::Url>,
) -> Box<dyn Installer + 'a> {
// if session is SchrootSession or if we're root, use apt
let mut installers: Vec<Box<dyn Installer + 'a>> = Vec::new();
#[cfg(feature = "debian")]
if scope == InstallationScope::Global && crate::session::which(session, "apt-get").is_some() {
log::info!(
"Using global installation scope and apt-get is available, so using apt installer"
);
installers.push(apt_installer(session, dep_server_url));
}
installers.extend(native_installers(session));
Box::new(StackedInstaller::new(installers))
}
/// Install missing dependencies.
///
/// This function takes a list of dependencies and installs them if they are not already present.
///
/// # Arguments
/// * `session` - The session to install the dependencies into.
/// * `installer` - The installer to use.
pub fn install_missing_deps(
session: &dyn Session,
installer: &dyn Installer,
scopes: &[InstallationScope],
deps: &[&dyn Dependency],
) -> Result<(), Error> {
if deps.is_empty() {
return Ok(());
}
let missing = deps
.iter()
.filter(|dep| !dep.present(session))
.collect::<Vec<_>>();
if !missing.is_empty() {
log::info!("Missing dependencies: {:?}", missing);
for dep in missing.into_iter() {
log::info!("Installing {:?}", dep);
let mut installed = false;
for scope in scopes {
match installer.install(*dep, *scope) {
Ok(()) => {
log::info!("Installed {:?}", dep);
installed = true;
break;
}
Err(Error::UnsupportedScope(_)) => {}
Err(e) => {
return Err(e);
}
}
}
if !installed {
return Err(Error::UnsupportedScopes(scopes.to_vec()));
}
}
}
Ok(())
}
/// Explain missing dependencies.
///
/// This function takes a list of dependencies and returns a list of explanations for how to
/// install them.
///
/// # Arguments
/// * `session` - The session to install the dependencies into.
/// * `installer` - The installer to use.
pub fn explain_missing_deps(
session: &dyn Session,
installer: &dyn Installer,
deps: &[&dyn Dependency],
) -> Result<Vec<Explanation>, Error> {
if deps.is_empty() {
return Ok(vec![]);
}
let mut missing = vec![];
for dep in deps.iter() {
if !dep.present(session) {
missing.push(*dep)
}
}
if !missing.is_empty() {
let mut explanations = vec![];
for dep in missing.into_iter() {
log::info!("Explaining {:?}", dep);
explanations.push(installer.explain(dep, InstallationScope::Global)?);
}
Ok(explanations)
} else {
Ok(vec![])
}
}
|