use anyhow::Result;
use std::path::Path;
use crate::config::EncodingConfig;
use crate::graph::Product;
pub struct EncodingProcessor {
config: EncodingConfig,
}
impl EncodingProcessor {
pub fn new(config: EncodingConfig) -> Self {
Self { config }
}
fn execute_product(&self, product: &Product) -> Result<()> {
self.check_files(&[product.primary_input()])
}
fn check_files(&self, files: &[&Path]) -> Result<()> {
let mut errors = Vec::new();
for file in files {
let bytes = crate::errors::ctx(std::fs::read(file), &format!("Failed to read {}", file.display()))?;
if let Err(msg) = validate_utf8(&bytes) {
errors.push(format!("{}: {}", file.display(), msg));
}
}
if errors.is_empty() {
Ok(())
} else {
anyhow::bail!("Encoding errors found:\n{}", errors.join("\n"))
}
}
}
fn validate_utf8(bytes: &[u8]) -> std::result::Result<(), String> {
if bytes.starts_with(&[0xEF, 0xBB, 0xBF]) {
return Err("file has UTF-8 BOM (byte order mark)".into());
}
if bytes.starts_with(&[0xFF, 0xFE]) || bytes.starts_with(&[0xFE, 0xFF]) {
return Err("file appears to be UTF-16 encoded".into());
}
if let Err(e) = std::str::from_utf8(bytes) {
let byte_pos = e.valid_up_to();
let line_num = bytes[..byte_pos].iter().filter(|&&b| b == b'\n').count() + 1;
return Err(format!("invalid UTF-8 at byte {} (line {})", byte_pos, line_num));
}
Ok(())
}
impl crate::processors::Processor for EncodingProcessor {
fn scan_config(&self) -> &crate::config::StandardConfig {
&self.config.standard
}
fn standard_config(&self) -> Option<&crate::config::StandardConfig> {
Some(&self.config.standard)
}
fn description(&self) -> &str {
"Validate that text files are valid UTF-8 without BOM"
}
fn required_tools(&self) -> Vec<String> {
Vec::new()
}
fn execute(&self, _ctx: &crate::build_context::BuildContext, product: &Product) -> Result<()> {
self.execute_product(product)
}
fn is_native(&self) -> bool { true }
fn supports_batch(&self) -> bool { self.config.standard.batch }
fn execute_batch(&self, ctx: &crate::build_context::BuildContext, products: &[&Product]) -> Vec<Result<()>> {
crate::processors::execute_checker_batch(ctx, products, |_ctx, files| self.check_files(files))
}
}
fn plugin_create(toml: &toml::Value) -> anyhow::Result<Box<dyn crate::processors::Processor>> {
crate::registries::deserialize_and_create(toml, |cfg| Box::new(EncodingProcessor::new(cfg)))
}
inventory::submit! {
crate::registries::ProcessorPlugin {
version: 1,
name: "encoding",
processor_type: crate::processors::ProcessorType::Checker,
create: plugin_create,
defconfig_json: crate::registries::default_config_json::<crate::config::EncodingConfig>,
known_fields: crate::registries::typed_known_fields::<crate::config::EncodingConfig>,
output_fields: crate::registries::typed_output_fields::<crate::config::EncodingConfig>,
must_fields: crate::registries::typed_must_fields::<crate::config::EncodingConfig>,
field_descriptions: crate::registries::typed_field_descriptions::<crate::config::EncodingConfig>,
keywords: &["checker", "encoding", "utf8", "text", "validator"],
description: "Validate that text files are valid UTF-8 without BOM",
is_native: true,
can_fix: false,
}
}