Skip to content

Commit

Permalink
Merge pull request #221 from Far-Beyond-Dev/212-fix-code-scanning-ale…
Browse files Browse the repository at this point in the history 
…rt-a-todo-or-similar-was-left-in-source-code-possibly-indicating-incomplete-functionality

212 fix code scanning alert a todo or similar was left in source code possibly indicating incomplete functionality
  • Loading branch information
@tristanpoland
tristanpoland authored Dec 30, 2024
2 parents 094cd60 + 6a72598 commit fe5bed8
Show file tree
Hide file tree
Showing 4 changed files with 112 additions and 76 deletions.
113 changes: 65 additions & 48 deletions plugin_api/build.rs
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use std::fs::{self, File};
use std::io::{Read, Write};
use std::path::Path;
use std::io::{Write, Read};

// Updated to include whether plugin has .allow-imports
type PluginInfo = (String, String, String, bool);
Expand All @@ -11,7 +11,10 @@ fn main() {
println!("cargo:info=Looking for plugins in: {:?}", plugins_dir);

if !plugins_dir.exists() {
println!("cargo:warning=Plugins directory not found at {:?}", plugins_dir);
println!(
"cargo:warning=Plugins directory not found at {:?}",
plugins_dir
);
return;
}

Expand All @@ -23,83 +26,92 @@ fn main() {
println!("cargo:warning=Failed to update Cargo.toml: {}", e);
std::process::exit(1);
}

// Update individual plugin Cargo.toml files if they have .allow-imports
if let Err(e) = update_plugin_cargo_tomls(&plugins_dir, &plugin_paths) {
println!("cargo:warning=Failed to update plugin Cargo.toml files: {}", e);
println!(
"cargo:warning=Failed to update plugin Cargo.toml files: {}",
e
);
std::process::exit(1);
}

if let Err(e) = generate_plugin_files(&plugin_paths) {
println!("cargo:warning=Failed to generate plugin files: {}", e);
std::process::exit(1);
}

println!("cargo:rerun-if-changed=../plugins");
println!("cargo:rerun-if-changed=Cargo.toml");
}

fn discover_plugins(plugins_dir: &Path) -> Vec<PluginInfo> {
let mut valid_plugins = Vec::new();

if let Ok(entries) = fs::read_dir(plugins_dir) {
for entry in entries.flatten() {
let path = entry.path();

if !path.is_dir() {
continue;
}

let plugin_name = path.file_name()

let plugin_name = path
.file_name()
.and_then(|n| n.to_str())
.unwrap_or("")
.to_string();

if plugin_name.is_empty() {
continue;
}

let cargo_toml = path.join("Cargo.toml");
let src_dir = path.join("src");
let lib_rs = path.join("src").join("lib.rs");
let allow_imports = path.join(".allow-imports");

if cargo_toml.exists() && src_dir.exists() && lib_rs.exists() {
if let Ok(mut file) = File::open(&cargo_toml) {
let mut contents = String::new();
if file.read_to_string(&mut contents).is_ok() {
let mut name = None;
let mut version = None;

for line in contents.lines() {
let line = line.trim();
if line.starts_with("name") {
name = line.split('=')
name = line
.split('=')
.nth(1)
.map(|s| s.trim().trim_matches('"').to_string());
} else if line.starts_with("version") {
version = line.split('=')
version = line
.split('=')
.nth(1)
.map(|s| s.trim().trim_matches('"').to_string());
}
}

if let (Some(name), Some(version)) = (name, version) {
let has_allow_imports = allow_imports.exists();
println!("cargo:warning=Found plugin: {} v{} in {} (allow-imports: {})",
name, version, plugin_name, has_allow_imports);
println!(
"cargo:warning=Found plugin: {} v{} in {} (allow-imports: {})",
name, version, plugin_name, has_allow_imports
);
valid_plugins.push((name, version, plugin_name, has_allow_imports));
}
}
}
}
}
}

valid_plugins
}

const AUTO_GENERATED_START: &str = "###### BEGIN AUTO-GENERATED PLUGIN DEPENDENCIES - DO NOT EDIT THIS SECTION ######";
const AUTO_GENERATED_START: &str =
"###### BEGIN AUTO-GENERATED PLUGIN DEPENDENCIES - DO NOT EDIT THIS SECTION ######";
const AUTO_GENERATED_END: &str = "###### END AUTO-GENERATED PLUGIN DEPENDENCIES ######";

fn update_cargo_toml(plugin_paths: &[PluginInfo]) -> std::io::Result<()> {
Expand All @@ -112,29 +124,25 @@ fn update_cargo_toml(plugin_paths: &[PluginInfo]) -> std::io::Result<()> {
let start_idx = contents.find(AUTO_GENERATED_START);

let base_contents = match start_idx {
Some(start) => {
contents[..start].trim_end().to_string()
}
None => {
contents.trim_end().to_string()
}
Some(start) => contents[..start].trim_end().to_string(),
None => contents.trim_end().to_string(),
};

let mut new_section = String::new();
new_section.push('\n');
new_section.push_str(AUTO_GENERATED_START);
new_section.push('\n');

let mut sorted_plugins = plugin_paths.to_vec();
sorted_plugins.sort_by(|a, b| a.0.cmp(&b.0));

for (name, version, plugin_dir, _) in sorted_plugins {
new_section.push_str(&format!(
"{} = {{ path = \"../plugins/{}\", version = \"{}\" }}\n",
name, plugin_dir, version
));
}

new_section.push_str(AUTO_GENERATED_END);

let mut final_contents = base_contents;
Expand All @@ -145,13 +153,17 @@ fn update_cargo_toml(plugin_paths: &[PluginInfo]) -> std::io::Result<()> {
}

fs::write(cargo_path, final_contents)?;

Ok(())
}

fn update_plugin_cargo_tomls(plugins_dir: &Path, plugin_paths: &[PluginInfo]) -> std::io::Result<()> {
fn update_plugin_cargo_tomls(
plugins_dir: &Path,
plugin_paths: &[PluginInfo],
) -> std::io::Result<()> {
// Get list of plugins that don't have .allow-imports
let regular_plugins: Vec<_> = plugin_paths.iter()
let regular_plugins: Vec<_> = plugin_paths
.iter()
.filter(|(_, _, _, has_allow)| !has_allow)
.collect();

Expand All @@ -171,12 +183,8 @@ fn update_plugin_cargo_tomls(plugins_dir: &Path, plugin_paths: &[PluginInfo]) ->
let end_idx = contents.find(AUTO_GENERATED_END);

let base_contents = match (start_idx, end_idx) {
(Some(start), Some(_)) => {
contents[..start].trim_end().to_string()
}
_ => {
contents.trim_end().to_string()
}
(Some(start), Some(_)) => contents[..start].trim_end().to_string(),
_ => contents.trim_end().to_string(),
};

let mut new_section = String::new();
Expand All @@ -186,7 +194,8 @@ fn update_plugin_cargo_tomls(plugins_dir: &Path, plugin_paths: &[PluginInfo]) ->

// Add dependencies for all non-.allow-imports plugins
for (dep_name, dep_version, dep_dir, _) in &regular_plugins {
if dep_name != name { // Don't add self as dependency
if dep_name != name {
// Don't add self as dependency
new_section.push_str(&format!(
"{} = {{ path = \"../{}\", version = \"{}\" }}\n",
dep_name, dep_dir, dep_version
Expand Down Expand Up @@ -218,32 +227,40 @@ fn generate_plugin_files(plugin_paths: &[PluginInfo]) -> std::io::Result<()> {

fn generate_imports_file(plugin_paths: &[PluginInfo], out_dir: &Path) -> std::io::Result<()> {
let mut file = fs::File::create(out_dir.join("plugin_imports.rs"))?;

writeln!(file, "// This file is automatically generated by build.rs")?;
writeln!(file, "// Do not edit this file manually!\n")?;
writeln!(file, "use std::collections::HashMap;\n")?;

write!(file, "pub use horizon_plugin_api::{{Plugin, Pluginstate, Version, get_plugin, LoadedPlugin}};\n\n")?;

for (name, _, _, _) in plugin_paths {
write!(file, "pub use {};\n", name)?;
write!(file, "pub use {}::*;\n", name)?;
write!(file, "pub use {}::Plugin as {}_plugin;\n", name, name)?;
write!(
file,
"pub use {}::PluginAPI as {}_plugin_api;\n",
name, name
)?;
}
writeln!(file, "\n")?;

writeln!(file, "// Invoke the macro with all discovered plugins")?;
writeln!(file, "pub fn load_plugins() -> HashMap<String, (Pluginstate, Plugin)> {{")?;
writeln!(
file,
"pub fn load_plugins() -> HashMap<String, (Pluginstate, Plugin)> {{"
)?;
write!(file, " let plugins = crate::load_plugins!(")?;

for (i, (name, _, _, _)) in plugin_paths.iter().enumerate() {
if i > 0 {
write!(file, ",")?;
}
write!(file, "\n {}", name)?;
}

writeln!(file, "\n );")?;
writeln!(file, " plugins")?;
writeln!(file, "}}")?;

Ok(())
}
}
8 changes: 5 additions & 3 deletions plugin_api/src/plugin_imports.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,17 @@

use std::collections::HashMap;

pub use horizon_plugin_api::{Plugin, Pluginstate, Version, get_plugin, LoadedPlugin};

pub use chronos_plugin;
pub use chronos_plugin::*;
pub use chronos_plugin::Plugin as chronos_plugin_plugin;
pub use chronos_plugin::PluginAPI as chronos_plugin_plugin_api;
pub use link_plugin;
pub use link_plugin::*;
pub use link_plugin::Plugin as link_plugin_plugin;
pub use link_plugin::PluginAPI as link_plugin_plugin_api;
pub use player_lib;
pub use player_lib::*;
pub use player_lib::Plugin as player_lib_plugin;
pub use player_lib::PluginAPI as player_lib_plugin_api;


// Invoke the macro with all discovered plugins
Expand Down
21 changes: 11 additions & 10 deletions server/src/main.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,12 @@
// License: Apache-2.0 //
//=============================================================================//

use std::sync::Once;
use anyhow::{Context, Result};
use once_cell::sync::Lazy;
use splash::splash;
use anyhow::{Context, Result};

use horizon_logger::{HorizonLogger, log_info};


use std::sync::Once;

use horizon_logger::{log_info, HorizonLogger};

mod server;
mod splash;
Expand All @@ -56,7 +53,12 @@ async fn main() -> Result<()> {

splash();
let config_init_time = std::time::Instant::now();
log_info!(LOGGER, "INIT", "Server config loaded in {:#?}", config_init_time.elapsed());
log_info!(
LOGGER,
"INIT",
"Server config loaded in {:#?}",
config_init_time.elapsed()
);

let init_time = std::time::Instant::now();

Expand All @@ -65,16 +67,15 @@ async fn main() -> Result<()> {
println!("Server started in {:#?}", init_time.elapsed());

let mut terminating: bool = false;

CTRL_C_HANDLER.call_once(|| {
// Register the Ctrl+C handler
ctrlc::set_handler(move || {
ctrlc::set_handler(move || {
if !terminating {
terminating = true;

println!("Exit");
std::process::exit(0);

}
})
.expect("Failed to register ctrl+c handler");
Expand Down
Loading

0 comments on commit fe5bed8

Please sign in to comment.