// Copyright 2015, 2016 Ethcore (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 . use std::sync::{Weak}; use std::{io, os, fs, env}; use std::path::{Path, PathBuf}; use util::misc::{VersionInfo, ReleaseTrack/*, platform*/}; use util::{Address, H160, H256, FixedHash, Mutex}; use client::operations::Operations; use client::{Client, UpdatePolicy, UpdateFilter, BlockId}; use fetch::HashFetch; use fetch; #[derive(Debug, Clone, PartialEq)] pub struct ReleaseInfo { pub version: VersionInfo, pub is_critical: bool, pub fork: u64, pub binary: Option, } #[derive(Debug, Clone, PartialEq)] pub struct OperationsInfo { pub fork: u64, pub track: ReleaseInfo, pub minor: Option, } pub struct Updater { client: Weak, fetch: Weak, operations: Operations, update_policy: UpdatePolicy, fetching: Mutex>, // These don't change pub this: VersionInfo, pub this_fork: Option, // This does change pub latest: Option, pub ready: Option, // If Some, client should restart itself. pub installed: Option, } const CLIENT_ID: &'static str = "parity"; fn platform() -> String { "test".to_owned() } impl Updater { pub fn new(client: Weak, fetch: Weak, operations: Address, update_policy: UpdatePolicy) -> Self { let mut u = Updater { client: client.clone(), fetch: fetch.clone(), operations: Operations::new(operations, move |a, d| client.upgrade().ok_or("No client!".into()).and_then(|c| c.call_contract(a, d))), update_policy: update_policy, fetching: Mutex::new(None), this: VersionInfo::this(), this_fork: None, latest: None, ready: None, installed: None, }; u.this_fork = u.operations.release(CLIENT_ID, &u.this.hash.into()).ok() .and_then(|(fork, track, _, _)| if track > 0 {Some(fork as u64)} else {None}); // TODO!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! REMOVE!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! if u.this.track == ReleaseTrack::Unknown { u.this.track = ReleaseTrack::Nightly; } u.latest = u.collect_latest().ok(); u } /// Is the currently running client capable of supporting the current chain? /// `Some` answer or `None` if information on the running client is not available. pub fn is_capable(&self) -> Option { self.latest.as_ref().and_then(|latest| { self.this_fork.map(|this_fork| { let current_number = self.client.upgrade().map_or(0, |c| c.block_number(BlockId::Latest).unwrap_or(0)); this_fork >= latest.fork || current_number < latest.fork }) }) } /// The release which is ready to be upgraded to, if any. If this returns `Some`, then /// `execute_upgrade` may be called. pub fn upgrade_ready(&self) -> Option { self.ready.clone() } #[cfg(windows)] fn symlink, Q: AsRef>(src: P, dst: Q) -> io::Result<()> { os::windows::fs::symlink_file(src, dst) } #[cfg(not(windows))] fn symlink, Q: AsRef>(src: P, dst: Q) -> io::Result<()> { os::unix::fs::symlink(src, dst) } /// Actually upgrades the client. Assumes that the binary has been downloaded. /// @returns `true` on success. pub fn execute_upgrade(&mut self) -> bool { (|| -> Result { if let Some(r) = self.ready.take() { let p = Self::update_file_path(&r.version); let n = Self::updates_latest(); let _ = fs::remove_file(&n); match Self::symlink(p, n) { Ok(_) => { info!("Completed upgrade to {}", &r.version); self.installed = Some(r); Ok(true) } Err(e) => { self.ready = Some(r); Err(format!("Unable to create soft-link for update {:?}", e)) } } } else { warn!("Execute upgrade called when no upgrade ready."); Ok(false) } })().unwrap_or_else(|e| { warn!("{}", e); false }) } /// Returns true iff the current version is capable of forming consensus. pub fn consensus_capable(&self) -> bool { /* if let Some(ref latest) = self.latest { */ unimplemented!() } /// Our version info. pub fn version_info(&self) -> &VersionInfo { &self.this } /// Information gathered concerning the release. pub fn info(&self) -> &Option { &self.latest } fn collect_release_info(&self, release_id: &H256) -> Result { let (fork, track, semver, is_critical) = self.operations.release(CLIENT_ID, release_id)?; let latest_binary = self.operations.checksum(CLIENT_ID, release_id, &platform())?; Ok(ReleaseInfo { version: VersionInfo::from_raw(semver, track, release_id.clone().into()), is_critical: is_critical, fork: fork as u64, binary: if latest_binary.is_zero() { None } else { Some(latest_binary) }, }) } fn collect_latest(&self) -> Result { if self.this.track == ReleaseTrack::Unknown { return Err(format!("Current executable ({}) is unreleased.", H160::from(self.this.hash))); } let latest_in_track = self.operations.latest_in_track(CLIENT_ID, self.this.track.into())?; let in_track = self.collect_release_info(&latest_in_track)?; let mut in_minor = Some(in_track.clone()); const PROOF: &'static str = "in_minor initialised and assigned with Some; loop breaks if None assigned; qed"; while in_minor.as_ref().expect(PROOF).version.track != self.this.track { let track = match in_minor.as_ref().expect(PROOF).version.track { ReleaseTrack::Beta => ReleaseTrack::Stable, ReleaseTrack::Nightly => ReleaseTrack::Beta, _ => { in_minor = None; break; } }; in_minor = Some(self.collect_release_info(&self.operations.latest_in_track(CLIENT_ID, track.into())?)?); } Ok(OperationsInfo { fork: self.operations.latest_fork()? as u64, track: in_track, minor: in_minor, }) } fn update_file_path(v: &VersionInfo) -> PathBuf { let mut dest = PathBuf::from(env::home_dir().unwrap().to_str().expect("env filesystem paths really should be valid; qed")); dest.push(".parity-updates"); dest.push(format!("parity-{}.{}.{}-{:?}", v.version.major, v.version.minor, v.version.patch, v.hash)); dest } fn updates_latest() -> PathBuf { let mut dest = PathBuf::from(env::home_dir().unwrap().to_str().expect("env filesystem paths really should be valid; qed")); dest.push(".parity-updates"); dest.push("parity"); dest } fn fetch_done(&mut self, result: Result) { (|| -> Result<(), String> { let fetched = self.fetching.lock().take().unwrap(); let b = result.map_err(|e| format!("Unable to fetch update ({}): {:?}", fetched.version, e))?; info!("Fetched latest version ({}) OK to {}", fetched.version, b.display()); let dest = Self::update_file_path(&fetched.version); fs::create_dir_all(dest.parent().expect("at least one thing pushed; qed")).map_err(|e| format!("Unable to create updates path: {:?}", e))?; fs::copy(&b, &dest).map_err(|e| format!("Unable to copy update: {:?}", e))?; info!("Copied file to {}", dest.display()); let auto = match self.update_policy.filter { UpdateFilter::All => true, UpdateFilter::Critical if fetched.is_critical /* TODO: or is on a bad fork */ => true, _ => false, }; self.ready = Some(fetched); if auto { self.execute_upgrade(); } Ok(()) })().unwrap_or_else(|e| warn!("{}", e)); } pub fn tick(&mut self) { info!(target: "updater", "Current release is {}", self.this); self.latest = self.collect_latest().ok(); let current_number = self.client.upgrade().map_or(0, |c| c.block_number(BlockId::Latest).unwrap_or(0)); if let Some(ref latest) = self.latest { info!(target: "updater", "Latest release in our track is v{} it is {}critical ({} binary is {})", latest.track.version, if latest.track.is_critical {""} else {"non-"}, platform(), if let Some(ref b) = latest.track.binary { format!("{}", b) } else { "unreleased".into() } ); if self.update_policy.enable_downloading && latest.track.version.hash != self.version_info().hash && self.installed.as_ref().or(self.ready.as_ref()).map_or(true, |t| *t != latest.track) { if let Some(b) = latest.track.binary { let mut fetching = self.fetching.lock(); if fetching.is_none() { info!("Attempting to get parity binary {}", b); let c = self.client.clone(); let f = move |r: Result| { if let Some(client) = c.upgrade() { if let Some(updater) = client.updater().as_mut() { updater.fetch_done(r); } } }; if let Some(fetch) = self.fetch.clone().upgrade() { fetch.fetch(b, Box::new(f)).ok(); *fetching = Some(latest.track.clone()); } } } } info!(target: "updater", "Fork: this/current/latest/latest-known: {}/#{}/#{}/#{}", match self.this_fork { Some(f) => format!("#{}", f), None => "unknown".into(), }, current_number, latest.track.fork, latest.fork); } } }