add build arch setting + no clobber option #10

Author: rusty-bits

Cargo.lock

@@ -2,7 +2,7 @@
 authors = ["rusty-bits <[email protected]>"]
 edition = "2021"
 name = "octool"
-version = "0.4.3"
+version = "0.4.4"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

Cargo.toml

@@ -16,22 +16,21 @@ You can build from the included source by running `cargo build --release` (if yo
 -h  print help/usage message then exit  
 
 -o x.y.z  select OpenCore version number to use e.g. `-o 0.7.4`  
- - without this option octool will make a quick guess as to which version to use based on the INPUT config.plist, if no INPUT config.plist is provided, octool will default to the latest version of OpenCore  
+ - without this option octool will make a quick guess as to which version to use based on the INPUT config.plist, if no INPUT config.plist is provided, octool will default to the latest OpenCore version  
 
 -v  print octool version information and booted OpenCore version if the var is in NVRAM then exit  
 
 octool takes a path to a `config.plist` to use if desired.
-If you run octool with no path provided `./octool` will first look for a `config.plist` in the `INPUT` folder, if it doesn't find one there it will use the corresponding `OpenCorePkg/Docs/Sample.plist` file.  
+If you run octool with no path provided `./octool` will look for `config.plist` in the `INPUT` folder, if it doesn't find it there it will use the `OpenCorePkg/Docs/Sample.plist` file.  
 
 ## Here's a rundown of the current process octool uses. ##  
 
 At startup, octool checks for a local copy of [the builds branch of the Dortania/build-repo](https://github.com/dortania/build-repo/tree/builds) so it will know the urls and hashes of the prebuilt binary resources.  Thank you [dhinakg](https://github.com/dhinakg), [hieplpvip](https://github.com/hieplpvip), and [khronokernel](https://github.com/khronokernel).  
- - If it finds it locally it updates it if needed 
- - If it doesn't find it locally octool downloads the `build-repo` into the `tool_config_files` folder.  
+ - It will update or download it to the `build-repo` into the `tool_config_files` folder as needed.  
 
 Next, octool does the same thing for [the master branch of the Acidanthera OpenCorePkg source files](https://github.com/acidanthera/OpenCorePkg), thanks to the [people of Acidanthera](https://github.com/acidanthera), in order to have the corresponding Sample.plist and Configuration.tex files, etc. for the version of OpenCore that you are building.  They will be placed into the `resources` folder along with the corresponding binaries from the Dortania builds.  This will allow `octool` to use Acidanthera tools while building the EFI, such as the ocvalitate and CreateVault tools.   Thanks, again [dhinakg](https://github.com/dhinakg).  
 
-As a last step, octool will run the input config.plist through ocvalitade, display any errors, and give you the option to quit or continue.  
+Lastly, octool will run the input config.plist through ocvalitade and give you the option to quit or continue.  
 If you continue you then enter the config.plist editor...  
 ```
 Navigation: arrow keys or some standard vi keys
@@ -67,29 +66,29 @@ Usage:
 
 'G' `go` (capital G) - make an OUTPUT/EFI/OC folder from the config.plist  
  - if `OpenCanopy.efi` is enabled it will copy the OcBinaryData Resources to `OUTPUT/EFI/OC/Resources`  
- - if Misc->Security->Vault is set to Basic or Secure, octool will compute the required files and sign the `OpenCore.efi` if needed  
- - right now, octool will ignore resources that it doesn't know unless they are placed in the INPUT folder, it will print out a warning, but it will not make a change to the config.plist for the unknown resource  
+ - if `Misc > Security > Vault` is set to `Basic` or `Secure`, octool will compute the required files and sign the `OpenCore.efi` if needed  
+ - octool will ignore resources that it doesn't know unless they are placed in the INPUT folder, it will print out a warning, but it will not make a change to the config.plist for the unknown resource  
  - any file placed in the `INPUT` folder will take priority and will be used for the `OUTPUT/EFI`, even if a more recent version of that resource is available elsewhere. This is good for using a specific version of a kext, for example, or for using a specific SSDT or USBMap  
  - lastly, it will again validate the `OUTPUT/EFI/OC/config.plist` file with ocvalidate  
 
 'i' show `info` of highlighted item.  
  - If item is resource such as a kext or driver, octool will show the source of the file it will place in the `OUTPUT/EFI` folder.  
- - If the highlighted item is a field of the config.plist, octool will show the description and info from the corresponding [Acidanthera](https://github.com/acidanthera) `Configuration.tex` file.  
+ - Otherwise, octool will show the description and info from the corresponding [Acidanthera](https://github.com/acidanthera) `Configuration.tex` file.  
 
 'K' `Key` - capital K - edit the name of the highlighted key  
 
-'M' `merge` - capital M - will add missing fields to the `config.plist` if they are in the `Sample.plist` without changing any existing fields.  
- - this command, coupled with its companion Purge command (capital P) will update a config.plist when any OpenCore plist format changes occur  
+'M' `merge` - capital M - will add missing fields to the `config.plist` from the `Sample.plist` without changing any existing fields.  
+ - this command, coupled with its companion Purge command (capital P) will update a config.plist when OpenCore plist format changes occur  
 
 'n' `next` - jump to the next found item if more than one occurance was found  
 
-'P' `purge` - Capital P - removes fields from the config.plist that are not in the Sample.plist  
- - this command, coupled with it's companion merge command (capital M) will update a config.plist when any OpenCore changes occur  
+'P' `purge` - Capital P - removes fields from the `config.plist` that are not in the `Sample.plist`  
+ - this command, coupled with it's companion merge command (capital M) will update a config.plist when OpenCore plst format changes occur  
 
 'p' `paste` - places the last deleted or modified etc. item into the plist (for those familiar with vi commands)  
  - if pasting into a dictionary, `octool` will append `-copy` to the pasted item  
 
-'q' `quit` - if unsaved changes were made to the `config.plist` octool will show a warning and allow changes to be saved or ignored  
+'q' `quit` - if unsaved changes were made to the `config.plist` octool will show a warning so changes can be saved  
 
 'r' `reset` - if a single item is selected, reset its value to the same as the `Sample.plist` value  
  - if a section is highlighted, reset the whole section to the same as the section in the `Sample.plist`  
@@ -99,7 +98,7 @@ Usage:
  - the saved file will be checked with `ocvalidate` for any errors  
 
 'V' `Version` - Capital V - change the version of OpenCore that will be checked against and used in the `OUTPUT` EFI  
- - if 'V' is used while a resource is highlighted, you can change the version of that specific resource  
+ - or, if 'V' is used while a resource is highlighted, you can change the version of that specific resource  
 
 'ctrl-x' `cut` - remove the highlighted field or section from the plist  
 
@@ -114,7 +113,7 @@ Usage:
  - `build-repo` folder - contains the `config.json` file from the Dortania builds repo with url, version, hash, date created, etc. info for the parent resources. octool will download this from Dortania if it doesn't exist    
  - `other.json` - contains a list of additional parent resources not included in the Dortania `build--repo`, octool will create this if it doesn't exist  
 
-`INPUT` folder - place `config.plist` here along with other files to be included in the `OUTPUT EFI`, such as custom SSDT files, custom Drivers, custom OpenCanopy themes, etc.  
+`INPUT` folder - place your `config.plist` here along with other files to be included in the `OUTPUT/EFI`, such as custom SSDT files, custom Drivers, custom OpenCanopy themes, etc.  
  - `octool` will not overwrite the input config.plist on save, instead it will save a version called `modified_config.plist` in this folder so the original `config.plist` can still be used if needed  
  - `octool` will also automatically save a config.plist titled `last_built_config.plist` when the build command is run for easy reference to a copy of the config.plist that is in the OUTPUT/EFI folder  
 
@@ -124,6 +123,5 @@ Usage:
 
 ## To Do: ##  
  - change tool configuration from inside tool, the configuration file `tool_config_files/octool_config.json` contains vars to set up octool, for example the language versions of the audio files for OpenCanopy for e.g. `en`  
- - add option to use IA32 versions instead of assuming X64  
  - keep the highlighted item on screen while reading long info from the Configuration.tex so the user can edit the field while also reading the info  
  - fix some style formatting of the info screens so underline, bold, etc. looks better when it crosses multiple lines  

README.md

@@ -23,11 +23,13 @@ pub fn build_output(
 
     let mut options = CopyOptions::new();
     options.overwrite = true;
-    let in_path;
-    if resources.open_core_binaries_path.join("X64/EFI").exists() {
-        in_path = "X64/EFI"; // TODO: add settings for IA32 as well instead of assuming X64
-    } else {
-        in_path = "EFI"; // older OpenCorePkg versions
+    let mut in_path = resources.octool_config["build_architecture"]
+        .as_str()
+        .unwrap_or("X64")
+        .to_string();
+    in_path.push_str("/EFI");
+    if !resources.open_core_binaries_path.join(&in_path).exists() {
+        in_path = "EFI".to_string(); // older OpenCorePkg versions
     }
     dir::copy(
         &resources.open_core_binaries_path.join(in_path),

src/build.rs

@@ -282,7 +282,10 @@ fn display_value(
                     let mut sec_sub = settings.sec_key[0].clone();
                     sec_sub.push_str(&settings.sec_key[1]);
                     if settings.resource_sections.contains(&sec_sub) {
-                        res::res_version(settings, &resources, &key)
+                        match res::res_version(settings, &resources, &key) {
+                            Some(s) => s,
+                            None => " \x1b[33m∆\x1b[0m ".to_string(),
+                        }
                     } else {
                         "".to_string()
                     }

src/draw.rs

@@ -9,7 +9,7 @@ mod snake;
 use fs_extra::dir::{copy, CopyOptions};
 use std::collections::HashMap;
 
-use std::fs::File;
+use std::fs::{self, File, ReadDir};
 use std::io::{stdout, BufReader, Stdout, Write};
 use std::path::{Path, PathBuf};
 use std::process::exit;
@@ -26,7 +26,7 @@ use crate::edit::read_key;
 use crate::init::{guess_version, Manifest, Settings};
 use crate::res::Resources;
 
-const OCTOOL_VERSION: &str = &"v0.4.3 2022-07-08";
+const OCTOOL_VERSION: &str = &"v0.4.4 2022-07-17";
 
 fn process(
     config_plist: &mut PathBuf,
@@ -131,8 +131,10 @@ fn process(
                         writeln!(stdout, "\n\x1B[32mFinished building OUTPUT/EFI\x1B[0m\r")?;
                         if &env::current_dir().unwrap() != current_dir {
                             writeln!(stdout, "Copying OUTPUT EFI folder to this directory\r")?;
-                            fs_extra::dir::remove(current_dir.join("EFI"))?;
-                            //are copy options needed anymore since the EFI is deleted first?
+
+                            delete_dir_contents(fs::read_dir(current_dir.join("EFI")));
+                            fs::remove_dir_all(current_dir.join("EFI"))?;
+
                             let mut options = CopyOptions::new();
                             options.overwrite = true;
                             copy("OUTPUT/EFI", current_dir, &options)?;
@@ -359,7 +361,11 @@ fn process(
                             if &parent_res != "OpenCorePkg" {
                                 let mut res_ver_name = String::new();
                                 settings.res_name(&mut res_ver_name);
-                                new_ver = res::res_version(settings, &resources, &res_ver_name);
+                                new_ver =
+                                    match res::res_version(settings, &resources, &res_ver_name) {
+                                        Some(s) => s,
+                                        None => "".to_string(),
+                                    }
                                 // versions[0].split("---").next().unwrap().trim().to_owned();
                             } else {
                                 new_ver = settings.oc_build_version.to_owned();
@@ -498,11 +504,6 @@ fn process(
                                 stdout,
                             )?;
                         }
-                        write!(
-                            stdout,
-                            "\x1b[4m{}\x1B[0K",
-                            " ".repeat(terminal::size()?.0.into())
-                        )?;
                         if !showing_info && empty_vec.len() == 0 {
                             settings.res_name(&mut res_name);
                             write!(
@@ -889,3 +890,23 @@ fn main() {
 
     terminal::disable_raw_mode().unwrap();
 }
+
+fn delete_dir_contents(read_dir_res: Result<ReadDir, std::io::Error>) {
+    if let Ok(dir) = read_dir_res {
+        for entry in dir {
+            if let Ok(entry) = entry {
+                let path = entry.path();
+
+                println!("removing {:?}", path);
+                if path.exists() {
+                    if path.is_dir() {
+                        delete_dir_contents(fs::read_dir(&path));
+                        fs::remove_dir_all(path).expect("Failed to remove a dir");
+                    } else {
+                        fs::remove_file(path).expect("Failed to remove a file");
+                    }
+                }
+            };
+        }
+    };
+}

src/main.rs

@@ -6,6 +6,7 @@ use std::{
 
 use crossterm::event::KeyCode;
 use crossterm::terminal::size;
+use crossterm::cursor::position;
 
 use crate::{edit::read_key, init::Settings, res::Resources};
 
@@ -279,6 +280,14 @@ pub fn show_info(
             }
         }
     }
+    write!(stdout, "\x1b[4m{}\x1B[0K", " ".repeat(size()?.0.into()))?;
+    write!(stdout, "\x1B8")?;
+    stdout.flush()?;
+    let bump_position = row + position()?.1 + 1;
+    if bump_position > rows {
+        write!(stdout, "\x1B8{}\x1B7", "\x1B[A".repeat(bump_position as usize - rows as usize))?;
+    }
+//    write!(stdout, " {} {} {} {} {}", bump_position, row, rows, position()?.0, position()?.1)?;
     stdout.flush()?;
     Ok(showing_info)
 }

src/parse_tex.rs

@@ -7,6 +7,7 @@ use std::process::{Command, Output};
 
 use curl::easy::Easy;
 use walkdir::WalkDir;
+use crossterm::terminal::size;
 
 use sha2::Digest;
 
@@ -300,7 +301,7 @@ pub fn show_res_info(resources: &Resources, settings: &Settings, stdout: &mut St
         stdout,
         "\r\n{}{}\r the first found resource will be used in the OUTPUT/EFI{}\r\n",
         "\x1b[4m",
-        " ".repeat(crossterm::terminal::size().unwrap().0.into()),
+        " ".repeat(size().unwrap().0.into()),
         bgc,
     )
     .unwrap();
@@ -430,6 +431,7 @@ pub fn show_res_info(resources: &Resources, settings: &Settings, stdout: &mut St
             }
         }
     }
+    write!(stdout, "\x1b[4m{}\x1B[0K", " ".repeat(size().unwrap().0.into())).unwrap();
 }
 
 /// Read the `path` file into a `serde_json::Value`
@@ -489,7 +491,7 @@ fn res_exists(
 
 /// version number of resource that will be used based on its manifest info
 /// if no manifest info exists for the resource, it will be looked up and stored
-pub fn res_version(settings: &mut Settings, resources: &Resources, res: &str) -> String {
+pub fn res_version(settings: &mut Settings, resources: &Resources, res: &str) -> Option<String> {
     let mut ver = String::new();
     let res = res.split("/").last().unwrap_or("");
     if let Some(parent_res) = resources.resource_list[res]["parent"].as_str() {
@@ -541,9 +543,9 @@ pub fn res_version(settings: &mut Settings, resources: &Resources, res: &str) ->
                 }
             }
         }
-        ver
+        Some(ver)
     } else {
-        " \x1b[33m∆\x1b[0m ".to_owned()
+        None
     }
 }
 

src/res.rs

@@ -1,5 +1,5 @@
 {
-  "octool_version": "v0.4.3 2022-07-08",
+  "octool_version": "v0.4.4 2022-07-17",
   "octool_releases_url": "https://github.com/rusty-bits/octool/releases",
   "octool_latest_config_url": "https://raw.githubusercontent.com/rusty-bits/octool/main/tool_config_files/octool_config.json",
   "octool_latest_dyn_res_list_url": "https://raw.githubusercontent.com/rusty-bits/octool/main/tool_config_files/dyn_res_list.zip",
@@ -15,19 +15,28 @@
   "current_configuration_tex": "https://raw.githubusercontent.com/acidanthera/OpenCorePkg/master/Docs/Configuration.tex",
   "current_sample_plist": "https://raw.githubusercontent.com/acidanthera/OpenCorePkg/master/Docs/Sample.plist",
 
+  "//comm_can_lang": "only include language files containing 'canopy_language' when OpenCanopy is used",
   "canopy_language": "en",
+
+  "//comm_glob_audio": "always include these audio files when OpenCanopy is used",
   "global_audio_files": [
     "AXEFIAudio_Beep.mp3",
     "AXEFIAudio_Click.mp3",
     "AXEFIAudio_VoiceOver_Boot.mp3"
   ],
 
+  "//comm_show_url": "show url in info screens in addition to link name",
   "show_url_in_info_screens": false,
 
+  "//comm_reset_ver": "when OpenCore version is changed, set other resource versions to match",
   "reset_res_versions": true,
 
+  "//comm_clob_local": "replace local res list with updated list when octool is run",
   "clobber_local_dyn_res_list": true,
 
+  "//comm_build": "set use of either 'X64' or 'IA32' build architecture",
+  "build_architecture": "X64",
+
   "resource_sections": [
     [
       "ACPI", "Add", "Path", "ACPI"