pcvolkmer/osc-variant
1
0
Fork 0
mirror of https://github.com/pcvolkmer/osc-variant.git synced 2025-04-19 19:56:50 +00:00
Code Issues

Issue #19: Check OSC files within OSB file

Browse Source
This commit is contained in:
Paul-Christian Volkmer 2023-11-08 11:17:10 +01:00
parent d45ded939e
commit 90423b5b4e
4 changed files with 175 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
src/checks/mod.rs
View File

@ -22,10 +22,15 @@
* SOFTWARE.
*/
pub mod osc;
use std::fmt::{Display, Formatter};
use std::path::Path;
use console::style;
use std::fmt::{Display, Formatter};
use deob::deobfuscate;
#[cfg(feature = "unzip-osb")]
pub mod osb;
pub mod osc;
pub enum CheckNotice {
/// This will result in Error if importing file and has a support code
@ -40,12 +45,16 @@ pub enum CheckNotice {
description: String,
line: Option<usize>,
},
#[allow(dead_code)]
/// Other known issues
Warning {
description: String,
line: Option<usize>,
},
/// Other known issues
Info {
description: String,
line: Option<usize>,
},
}
impl Display for CheckNotice {
@ -59,7 +68,7 @@ impl Display for CheckNotice {
} => match line {
Some(line) => write!(
f,
"{} ({}) at Line {}: {}{}",
"{: <7} ({}) at Line {}: {}{}",
style("ERROR").red().bold(),
code,
line,
@ -71,7 +80,7 @@ impl Display for CheckNotice {
),
None => write!(
f,
"{} ({}): {}{}",
"{: <7} ({}): {}{}",
style("ERROR").red().bold(),
code,
description,
@ -84,22 +93,37 @@ impl Display for CheckNotice {
CheckNotice::Error { description, line } => match line {
Some(line) => write!(
f,
"{} at Line {}: {}",
"{: <7} at Line {}: {}",
style("ERROR").red().bold(),
line,
description
),
None => write!(f, "{}: {}", style("ERROR").red().bold(), description),
None => write!(f, "{: <7} {}", style("ERROR").red().bold(), description),
},
CheckNotice::Warning { description, line } => match line {
Some(line) => write!(
f,
"{} at Line {}: {}",
"{: <7} at Line {}: {}",
style("WARNING").yellow().bold(),
line,
description
),
None => write!(f, "{}: {}", style("WARNING").yellow().bold(), description),
None => write!(
f,
"{: <7} {}",
style("WARNING").yellow().bold(),
description
),
},
CheckNotice::Info { description, line } => match line {
Some(line) => write!(
f,
"{: <7} at Line {}: {}",
style("INFO").blue().bold(),
line,
description
),
None => write!(f, "{: <7} {}", style("INFO").blue().bold(), description),
},
}
}
@ -113,6 +137,27 @@ pub trait Fixable {
fn fix(&mut self) -> bool;
}
pub fn check_file(file: &Path, password: Option<String>) -> Vec<CheckNotice> {
match file.extension() {
Some(ex) => match ex.to_str() {
#[cfg(feature = "unzip-osb")]
Some("osb") => match password {
Some(password) => osb::check_file(file, password.as_str()),
None => osb::check_file(file, deobfuscate(env!("OSB_KEY").trim()).as_str()),
},
Some("osc") => osc::check_file(file),
_ => vec![CheckNotice::Error {
description: "Keine prüfbare Datei".to_string(),
line: None,
}],
},
_ => vec![CheckNotice::Error {
description: "Keine prüfbare Datei".to_string(),
line: None,
}],
}
}
pub fn print_checks() {
println!(
"{}",
@ -144,17 +189,34 @@ pub fn print_checks() {
}
}
vec![Problem {
vec![
Problem {
code: "2023-0001",
name: "Unterformular mit Markierung 'hat Unterformulare'",
description: " Aktuell gibt es keine Unterformulare in Unterformularen, daher\n \
sollte dies nicht vorkommen.",
fixable: false,
},
Problem {
code: "2023-0002",
name: "Formular hat keine Angabe zum Prozedurdatum",
description: " Formulare benötigen die Angabe des Prozedurdatums, anderenfalls\n \
führt dies zu Problemen in Onkostar.\n\n \
Unterformulare können ein Prozedurdatum haben, müssen es aber nicht.",
fixable: false,
},
Problem {
code: "2023-0003",
name: "Leerzeichen am Ende der Plausibilitätsregel-Bezeichnung (OSTARSUPP-13334)",
description: "Treten Leerzeichen am Ende der Plausibilitätsregel-Bezeichnung auf,\n\
führt dies zu Fehlern beim Import der OSC-Datei.\n\
\n\
Das Problem wird beim Verwenden des Unterbefehls 'modify' automatisch\n\
description:
" Treten Leerzeichen am Ende der Plausibilitätsregel-Bezeichnung auf,\n \
führt dies zu Fehlern beim Import der OSC-Datei.\n\n \
Das Problem wird beim Verwenden des Unterbefehls 'modify' automatisch\n \
behoben und Leerzeichen entfernt.
",
fixable: true,
}]
},
]
.iter()
.for_each(|problem| println!("{}\n", problem))
}

80
src/checks/osb.rs Normal file
View File

@ -0,0 +1,80 @@
/*
* MIT License
*
* Copyright (c) 2023 Comprehensive Cancer Center Mainfranken
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
use std::fs;
use std::io::Read;
use std::path::Path;
use crate::checks::{osc, CheckNotice};
#[cfg(feature = "unzip-osb")]
pub fn check_file(file: &Path, password: &str) -> Vec<CheckNotice> {
let file = match fs::File::open(file) {
Ok(file) => file,
Err(err) => {
return vec![CheckNotice::Error {
description: format!("Kann Datei nicht lesen: {}", err),
line: None,
}];
}
};
let mut archive = match zip::ZipArchive::new(file) {
Ok(file) => file,
Err(err) => {
return vec![CheckNotice::Error {
description: format!("Kann Datei nicht lesen: {}", err),
line: None,
}];
}
};
let mut result = vec![];
for i in 0..archive.len() {
if let Ok(Ok(mut zip_file)) = archive.by_index_decrypt(i, password.as_bytes()) {
if zip_file.is_file() && zip_file.name().ends_with(".osc") {
result.push(CheckNotice::Info {
description: format!("Prüfe Eintrag '{}'", zip_file.name()),
line: None,
});
let mut buf = String::new();
let _ = zip_file.read_to_string(&mut buf);
result.append(&mut osc::check(buf));
continue;
}
result.push(CheckNotice::Warning {
description: format!("Überspringe Eintrag '{}'", zip_file.name()),
line: None,
})
} else {
return vec![CheckNotice::Error {
description: format!("Kann Datei nicht lesen"),
line: None,
}];
}
}
result
}

6
src/cli.rs
View File

@ -109,6 +109,12 @@ pub enum SubCommand {
#[command(about = "Überprüfe OSC-Datei auf bekannte Problemen")]
Check {
file: String,
#[arg(
short = 'p',
long = "password",
help = "Passwort der OSB-Datei (Optional - für OSB-Dateien)"
)]
password: Option<String>,
#[arg(
long = "list",
help = "Prüfe nicht und zeige Liste mit Checks auf bekannte Problemen"

11
src/main.rs
View File

@ -31,8 +31,7 @@ use std::ops::Add;
use std::path::{Path, PathBuf};
use std::str::FromStr;
use crate::checks::osc::check;
use crate::checks::print_checks;
use crate::checks::{check_file, print_checks, CheckNotice};
use clap::Parser;
use console::style;
use dialoguer::Confirm;
@ -265,11 +264,15 @@ fn main() -> Result<(), Box<dyn Error>> {
}
};
}
SubCommand::Check { file, list } => {
SubCommand::Check {
file,
list,
password,
} => {
if list {
print_checks();
} else {
let notices = check(Path::new(file.as_str()));
let notices = check_file(Path::new(file.as_str()), password);
println!(
"Es wurden {} Probleme gefunden\n",
notices