This commit is contained in:
James 2018-08-07 20:19:26 +10:00
commit bada9d18c2
12 changed files with 209 additions and 113 deletions

View File

@ -1,31 +1,2 @@
[general]
name = "yuzu"
installing_message = "Reminder: yuzu is an <b>experimental</b> emulator. Stuff will break!"
[[packages]]
name = "yuzu Nightly"
description = "The nightly build of yuzu contains already reviewed and tested features."
[packages.source]
name = "github"
match = "^yuzu-#PLATFORM#(-mingw)?-[0-9]*-[0-9a-f]*.zip$"
[packages.source.config]
repo = "yuzu-emu/yuzu-nightly"
[[packages]]
name = "yuzu Canary"
description = "The canary build of yuzu has additional features that are still waiting on review."
[packages.source]
name = "github"
match = "^yuzu-#PLATFORM#(-mingw)?-[0-9]*-[0-9a-f]*.zip$"
[packages.source.config]
repo = "yuzu-emu/yuzu-canary"
[[packages]]
name = "Test package"
description = "Just a testing package"
default = true
[packages.source]
name = "github"
match = "^TestPackage.zip$"
[packages.source.config]
repo = "j-selby/test-installer"
target_url = "https://raw.githubusercontent.com/j-selby/test-installer/master/config.v1.toml"

View File

@ -30,14 +30,26 @@ pub struct PackageDescription {
/// Describes the application itself.
#[derive(Debug, Deserialize, Serialize, Clone)]
pub struct GeneralConfig {
pub struct BaseAttributes {
pub name: String,
pub installing_message: String,
pub target_url: String,
}
impl BaseAttributes {
/// Serialises as a JSON string.
pub fn to_json_str(&self) -> Result<String, SerdeError> {
serde_json::to_string(self)
}
/// Builds a configuration from a specified TOML string.
pub fn from_toml_str(contents: &str) -> Result<Self, TomlError> {
toml::from_str(contents)
}
}
#[derive(Debug, Deserialize, Serialize, Clone)]
pub struct Config {
pub general: GeneralConfig,
pub installing_message: String,
pub packages: Vec<PackageDescription>,
}

View File

@ -8,6 +8,19 @@ use reqwest;
use std::io::Read;
/// Downloads a text file from the specified URL.
pub fn download_text(url: &str) -> Result<String, String> {
// TODO: Decrease check time
let mut client = match reqwest::get(url) {
Ok(v) => v,
Err(v) => return Err(format!("Failed to GET resource: {:?}", v)),
};
client
.text()
.map_err(|v| format!("Failed to get text from resource: {:?}", v))
}
/// Streams a file from a HTTP server.
pub fn stream_file<F>(url: &str, mut callback: F) -> Result<(), String>
where

View File

@ -13,6 +13,7 @@ use std::path::PathBuf;
use std::sync::mpsc::Sender;
use config::BaseAttributes;
use config::Config;
use sources::types::Version;
@ -36,7 +37,8 @@ pub enum InstallMessage {
/// The installer framework contains metadata about packages, what is installable, what isn't,
/// etc.
pub struct InstallerFramework {
pub config: Config,
pub base_attributes: BaseAttributes,
pub config: Option<Config>,
pub database: Vec<LocalInstallation>,
pub install_path: Option<PathBuf>,
pub preexisting_install: bool,
@ -64,13 +66,13 @@ pub struct LocalInstallation {
impl InstallerFramework {
/// Returns a copy of the configuration.
pub fn get_config(&self) -> Config {
pub fn get_config(&self) -> Option<Config> {
self.config.clone()
}
/// Returns the default install path.
pub fn get_default_path(&self) -> Option<String> {
let app_name = &self.config.general.name;
let app_name = &self.base_attributes.name;
let base_dir = match var("LOCALAPPDATA") {
Ok(path) => PathBuf::from(path),
@ -194,9 +196,10 @@ impl InstallerFramework {
}
/// Creates a new instance of the Installer Framework with a specified Config.
pub fn new(config: Config) -> Self {
pub fn new(attrs: BaseAttributes) -> Self {
InstallerFramework {
config,
base_attributes: attrs,
config: None,
database: Vec::new(),
install_path: None,
preexisting_install: false,
@ -207,7 +210,7 @@ impl InstallerFramework {
/// Creates a new instance of the Installer Framework with a specified Config, managing
/// a pre-existing installation.
pub fn new_with_db(config: Config, install_path: &Path) -> Result<Self, String> {
pub fn new_with_db(attrs: BaseAttributes, install_path: &Path) -> Result<Self, String> {
let path = install_path.to_owned();
let metadata_path = path.join("metadata.json");
let metadata_file = match File::open(metadata_path) {
@ -221,7 +224,8 @@ impl InstallerFramework {
};
Ok(InstallerFramework {
config,
base_attributes: attrs,
config: None,
database,
install_path: Some(path),
preexisting_install: true,

View File

@ -17,7 +17,8 @@ pub fn setup_logger() -> Result<(), fern::InitError> {
record.level(),
message
))
}).level(log::LevelFilter::Info)
})
.level(log::LevelFilter::Info)
.chain(io::stdout())
.chain(fern::log_file("installer.log")?)
.apply()?;
@ -31,6 +32,7 @@ where
Self: Sized,
{
/// Unwraps this object. See `unwrap()`.
#[inline]
fn log_unwrap(self) -> T {
self.log_expect("Failed to unwrap")
}
@ -40,6 +42,7 @@ where
}
impl<T, E: Debug> LoggingErrors<T> for Result<T, E> {
#[inline]
fn log_expect(self, msg: &str) -> T {
match self {
Ok(v) => v,
@ -52,6 +55,7 @@ impl<T, E: Debug> LoggingErrors<T> for Result<T, E> {
}
impl<T> LoggingErrors<T> for Option<T> {
#[inline]
fn log_expect(self, msg: &str) -> T {
match self {
Some(v) => v,

View File

@ -50,8 +50,6 @@ mod tasks;
use web_view::*;
use config::Config;
use installer::InstallerFramework;
#[cfg(windows)]
@ -71,7 +69,8 @@ use clap::App;
use clap::Arg;
use log::Level;
// TODO: Fetch this over a HTTP request?
use config::BaseAttributes;
static RAW_CONFIG: &'static str = include_str!("../config.toml");
#[derive(Deserialize, Debug)]
@ -83,9 +82,10 @@ enum CallbackType {
fn main() {
logging::setup_logger().expect("Unable to setup logging!");
let config = Config::from_toml_str(RAW_CONFIG).log_expect("Config file could not be read");
let config =
BaseAttributes::from_toml_str(RAW_CONFIG).log_expect("Config file could not be read");
let app_name = config.general.name.clone();
let app_name = config.name.clone();
let matches = App::new(format!("{} installer", app_name))
.version(env!("CARGO_PKG_VERSION"))
@ -96,7 +96,8 @@ fn main() {
.value_name("TARGET")
.help("Launches the specified executable after checking for updates")
.takes_value(true),
).get_matches();
)
.get_matches();
info!("{} installer", app_name);

View File

@ -32,6 +32,10 @@ use installer::InstallerFramework;
use logging::LoggingErrors;
use std::process::Command;
use http;
use config::Config;
#[derive(Serialize)]
struct FileSelection {
path: Option<String>,
@ -55,7 +59,8 @@ impl WebServer {
Ok(WebService {
framework: framework.clone(),
})
}).log_expect("Failed to bind to port");
})
.log_expect("Failed to bind to port");
server.run().log_expect("Failed to run HTTP server");
});
@ -79,16 +84,16 @@ impl Service for WebService {
fn call(&self, req: Self::Request) -> Self::Future {
Box::new(future::ok(match (req.method(), req.path()) {
// This endpoint should be usable directly from a <script> tag during loading.
(&Get, "/api/config") => {
(&Get, "/api/attrs") => {
let framework = self
.framework
.read()
.log_expect("InstallerFramework has been dirtied");
let file = encapsulate_json(
"config",
"base_attributes",
&framework
.get_config()
.base_attributes
.to_json_str()
.log_expect("Failed to render JSON representation of config"),
);
@ -98,6 +103,59 @@ impl Service for WebService {
.with_header(ContentType::json())
.with_body(file)
}
// Returns the web config loaded
(&Get, "/api/config") => {
let mut framework = self
.framework
.write()
.log_expect("InstallerFramework has been dirtied");
info!(
"Downloading configuration from {:?}...",
framework.base_attributes.target_url
);
match http::download_text(&framework.base_attributes.target_url)
.map(|x| Config::from_toml_str(&x))
{
Ok(Ok(config)) => {
framework.config = Some(config.clone());
info!("Configuration file downloaded successfully.");
let file = framework
.get_config()
.log_expect("Config should be loaded by now")
.to_json_str()
.log_expect("Failed to render JSON representation of config");
Response::<hyper::Body>::new()
.with_header(ContentLength(file.len() as u64))
.with_header(ContentType::json())
.with_body(file)
}
Ok(Err(v)) => {
error!("Bad configuration file: {:?}", v);
Response::<hyper::Body>::new()
.with_status(StatusCode::ServiceUnavailable)
.with_header(ContentType::plaintext())
.with_body("Bad HTTP response")
}
Err(v) => {
error!(
"General connectivity error while downloading config: {:?}",
v
);
Response::<hyper::Body>::new()
.with_status(StatusCode::ServiceUnavailable)
.with_header(ContentLength(v.len() as u64))
.with_header(ContentType::plaintext())
.with_body(v)
}
}
}
// This endpoint should be usable directly from a <script> tag during loading.
(&Get, "/api/packages") => {
let framework = self

View File

@ -40,7 +40,8 @@ impl ReleaseSource for GithubReleases {
.get(&format!(
"https://api.github.com/repos/{}/releases",
config.repo
)).header(UserAgent::new("liftinstall (j-selby)"))
))
.header(UserAgent::new("liftinstall (j-selby)"))
.send()
.map_err(|x| format!("Error while sending HTTP request: {:?}", x))?;
@ -52,8 +53,8 @@ impl ReleaseSource for GithubReleases {
.text()
.map_err(|x| format!("Failed to decode HTTP response body: {:?}", x))?;
let result: serde_json::Value = serde_json::from_str(&body)
.map_err(|x| format!("Failed to parse response: {:?}", x))?;
let result: serde_json::Value =
serde_json::from_str(&body).map_err(|x| format!("Failed to parse response: {:?}", x))?;
let result: &Vec<serde_json::Value> = result
.as_array()

View File

@ -41,7 +41,12 @@ impl Task for InstallPackageTask {
let mut installed_files = Vec::new();
let mut metadata: Option<PackageDescription> = None;
for description in &context.config.packages {
for description in &context
.config
.as_ref()
.log_expect("Should have packages by now")
.packages
{
if self.name == description.name {
metadata = Some(description.clone());
break;

View File

@ -26,7 +26,12 @@ impl Task for ResolvePackageTask {
) -> Result<TaskParamType, String> {
assert_eq!(input.len(), 0);
let mut metadata: Option<PackageDescription> = None;
for description in &context.config.packages {
for description in &context
.config
.as_ref()
.log_expect("Should have packages by now")
.packages
{
if self.name == description.name {
metadata = Some(description.clone());
break;

View File

@ -21,7 +21,7 @@
<div class="columns">
<div class="column is-one-third has-padding" v-if="!is_launcher">
<h1 class="title">
Welcome to the {{ config.general.name }} installer!
Welcome to the {{ attrs.name }} installer!
</h1>
<h2 class="subtitle">
We will have you up and running in just a few moments.
@ -37,6 +37,15 @@
<a class="button is-dark is-pulled-right" v-on:click="back_to_packages">Back</a>
</div>
<div class="column" v-else-if="is_downloading_config">
<h4 class="subtitle">Downloading config...</h4>
<div v-html="progress_message"></div>
<progress class="progress is-info is-medium" v-bind:value="progress" max="100">
{{ progress }}%
</progress>
</div>
<div v-else-if="modify_install">
<h4 class="subtitle">Choose an option:</h4>
@ -104,7 +113,7 @@
<div v-else-if="is_installing">
<h4 class="subtitle" v-if="is_launcher">Checking for updates...</h4>
<h4 class="subtitle" v-else>Installing...</h4>
<div v-html="config.general.installing_message"></div>
<div v-html="config.installing_message"></div>
<br />
<div v-html="progress_message"></div>
@ -116,7 +125,7 @@
</div>
<div v-else-if="is_finished">
<h4 class="subtitle">Thanks for installing {{ config.general.name }}!</h4>
<h4 class="subtitle">Thanks for installing {{ attrs.name }}!</h4>
<a class="button is-dark is-pulled-right" v-on:click="exit">Exit</a>
</div>
@ -134,7 +143,7 @@
<div class="modal-background"></div>
<div class="modal-card">
<header class="modal-card-head">
<p class="modal-card-title">Are you sure you want to uninstall {{ config.general.name }}?</p>
<p class="modal-card-title">Are you sure you want to uninstall {{ attrs.name }}?</p>
</header>
<footer class="modal-card-foot">
<button class="button is-danger" v-on:click="uninstall">Yes</button>
@ -144,7 +153,7 @@
</div>
</div>
<script src="/api/config"></script>
<script src="/api/attrs"></script>
<script src="/js/helpers.js"></script>
<script src="/js/vue.min.js"></script>
<script>
@ -176,7 +185,7 @@
intercept(methods[i]);
}
document.getElementById("window-title").innerText = config.name + " Installer";
document.getElementById("window-title").innerText = base_attributes.name + " Installer";
function selectFileCallback(name) {
app.install_location = name;
@ -185,7 +194,8 @@
var app = new Vue({
el: '#app',
data: {
config : config,
attrs: base_attributes,
config : {},
install_location : "",
// If the initial modify menu should be shown
modify_install : false,
@ -200,6 +210,8 @@
launcher_path : undefined,
// If a confirmation prompt should be shown
confirm_uninstall : false,
// If the downloading config page should be shown
is_downloading_config : false,
progress : 0,
progress_message : "",
has_error : false,
@ -213,6 +225,59 @@
}
},
methods: {
"download_config": function() {
app.is_downloading_config = true;
ajax("/api/config", function(e) {
app.download_install_status();
app.config = e;
});
},
"download_install_status": function() {
ajax("/api/installation-status", function(e) {
app.is_downloading_config = false;
app.metadata = e;
if (e.preexisting_install) {
app.modify_install = true;
app.select_packages = false;
app.show_install_location = false;
app.install_location = e.install_path;
// Copy over installed packages
for (var x = 0; x < app.config.packages.length; x++) {
app.config.packages[x].default = false;
app.config.packages[x].installed = false;
}
for (var i = 0; i < app.metadata.database.length; i++) {
// Find this config package
for (var x = 0; x < app.config.packages.length; x++) {
if (app.config.packages[x].name === app.metadata.database[i].name) {
app.config.packages[x].default = true;
app.config.packages[x].installed = true;
}
}
}
if (e.is_launcher) {
document.getElementById("window-title").innerText = app.attrs.name + " Updater";
app.is_launcher = true;
app.install();
}
} else {
for (var x = 0; x < app.config.packages.length; x++) {
app.config.packages[x].installed = false;
}
ajax("/api/default-path", function(e) {
if (e.path != null) {
app.install_location = e.path;
}
});
}
});
},
"select_file": function() {
window.external.invoke(JSON.stringify({
SelectInstallDir: {
@ -310,48 +375,7 @@
}
});
ajax("/api/installation-status", function(e) {
app.metadata = e;
if (e.preexisting_install) {
app.modify_install = true;
app.select_packages = false;
app.show_install_location = false;
app.install_location = e.install_path;
// Copy over installed packages
for (var x = 0; x < app.config.packages.length; x++) {
app.config.packages[x].default = false;
app.config.packages[x].installed = false;
}
for (var i = 0; i < app.metadata.database.length; i++) {
// Find this config package
for (var x = 0; x < app.config.packages.length; x++) {
if (app.config.packages[x].name === app.metadata.database[i].name) {
app.config.packages[x].default = true;
app.config.packages[x].installed = true;
}
}
}
if (e.is_launcher) {
document.getElementById("window-title").innerText = config.name + " Updater";
app.is_launcher = true;
app.install();
}
} else {
for (var x = 0; x < app.config.packages.length; x++) {
app.config.packages[x].installed = false;
}
ajax("/api/default-path", function(e) {
if (e.path != null) {
app.install_location = e.path;
}
});
}
});
app.download_config();
</script>
</body>
</html>

View File

@ -26,7 +26,7 @@ function ajax(path, successCallback, failCallback, data) {
if (this.status === 200 && this.getResponseHeader('Content-Type').indexOf("application/json") !== -1) {
successCallback(JSON.parse(this.responseText));
} else {
failCallback();
failCallback(this.responseText);
}
});
req.addEventListener("error", failCallback);
@ -69,7 +69,7 @@ function stream_ajax(path, callback, successCallback, failCallback, data) {
if (this.status === 200) {
successCallback(this.responseText);
} else {
failCallback();
failCallback(this.responseText);
}
});
@ -77,14 +77,12 @@ function stream_ajax(path, callback, successCallback, failCallback, data) {
req.onreadystatechange = function() {
if(req.readyState > 2) {
var newData = req.responseText.substr(req.seenBytes);
buffer += newData;
buffer += req.responseText.substr(req.seenBytes);
var pointer;
while ((pointer = newData.indexOf("\n")) >= 0) {
var line = newData.substring(0, pointer).trim();
newData = newData.substring(pointer + 1);
while ((pointer = buffer.indexOf("\n")) >= 0) {
var line = buffer.substring(0, pointer).trim();
buffer = buffer.substring(pointer + 1);
if (line.length === 0) {
continue;