488 lines
19 KiB
Rust
488 lines
19 KiB
Rust
use std::fs::{File, Metadata};
|
|
use std::io::prelude::*;
|
|
use std::io::BufWriter;
|
|
use std::path::PathBuf;
|
|
use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
|
|
use std::sync::Arc;
|
|
use std::thread::sleep;
|
|
use std::time::{Duration, SystemTime, UNIX_EPOCH};
|
|
use std::{fs, thread};
|
|
|
|
use crossbeam_channel::Receiver;
|
|
use rayon::prelude::*;
|
|
|
|
use crate::common::Common;
|
|
use crate::common_directory::Directories;
|
|
use crate::common_extensions::Extensions;
|
|
use crate::common_items::ExcludedItems;
|
|
use crate::common_messages::Messages;
|
|
use crate::common_traits::*;
|
|
use crate::fl;
|
|
use crate::localizer::generate_translation_hashmap;
|
|
|
|
#[derive(Debug)]
|
|
pub struct ProgressData {
|
|
pub current_stage: u8,
|
|
pub max_stage: u8,
|
|
pub files_checked: usize,
|
|
}
|
|
|
|
#[derive(Eq, PartialEq, Clone, Debug)]
|
|
pub enum DeleteMethod {
|
|
None,
|
|
Delete,
|
|
}
|
|
|
|
const MAX_NUMBER_OF_SYMLINK_JUMPS: i32 = 20;
|
|
|
|
#[derive(Clone)]
|
|
pub enum ErrorType {
|
|
InfiniteRecursion,
|
|
NonExistentFile,
|
|
}
|
|
|
|
#[derive(Clone)]
|
|
pub struct FileEntry {
|
|
pub symlink_path: PathBuf,
|
|
pub destination_path: PathBuf,
|
|
pub type_of_error: ErrorType,
|
|
pub modified_date: u64,
|
|
}
|
|
|
|
/// Info struck with helpful information's about results
|
|
#[derive(Default)]
|
|
pub struct Info {
|
|
pub number_of_invalid_symlinks: usize,
|
|
pub number_of_removed_files: usize,
|
|
pub number_of_failed_to_remove_files: usize,
|
|
}
|
|
|
|
impl Info {
|
|
pub fn new() -> Self {
|
|
Default::default()
|
|
}
|
|
}
|
|
|
|
/// Struct with required information's to work
|
|
pub struct InvalidSymlinks {
|
|
text_messages: Messages,
|
|
information: Info,
|
|
invalid_symlinks: Vec<FileEntry>,
|
|
directories: Directories,
|
|
allowed_extensions: Extensions,
|
|
excluded_items: ExcludedItems,
|
|
recursive_search: bool,
|
|
delete_method: DeleteMethod,
|
|
stopped_search: bool,
|
|
}
|
|
|
|
impl InvalidSymlinks {
|
|
pub fn new() -> Self {
|
|
Self {
|
|
text_messages: Messages::new(),
|
|
information: Info::new(),
|
|
recursive_search: true,
|
|
allowed_extensions: Extensions::new(),
|
|
directories: Directories::new(),
|
|
excluded_items: ExcludedItems::new(),
|
|
invalid_symlinks: vec![],
|
|
delete_method: DeleteMethod::None,
|
|
stopped_search: false,
|
|
}
|
|
}
|
|
|
|
pub fn find_invalid_links(&mut self, stop_receiver: Option<&Receiver<()>>, progress_sender: Option<&futures::channel::mpsc::UnboundedSender<ProgressData>>) {
|
|
self.directories.optimize_directories(self.recursive_search, &mut self.text_messages);
|
|
if !self.check_files(stop_receiver, progress_sender) {
|
|
self.stopped_search = true;
|
|
return;
|
|
}
|
|
self.delete_files();
|
|
self.debug_print();
|
|
}
|
|
|
|
pub fn get_stopped_search(&self) -> bool {
|
|
self.stopped_search
|
|
}
|
|
|
|
pub const fn get_invalid_symlinks(&self) -> &Vec<FileEntry> {
|
|
&self.invalid_symlinks
|
|
}
|
|
|
|
pub const fn get_text_messages(&self) -> &Messages {
|
|
&self.text_messages
|
|
}
|
|
|
|
pub const fn get_information(&self) -> &Info {
|
|
&self.information
|
|
}
|
|
|
|
pub fn set_delete_method(&mut self, delete_method: DeleteMethod) {
|
|
self.delete_method = delete_method;
|
|
}
|
|
|
|
pub fn set_recursive_search(&mut self, recursive_search: bool) {
|
|
self.recursive_search = recursive_search;
|
|
}
|
|
|
|
pub fn set_included_directory(&mut self, included_directory: Vec<PathBuf>) -> bool {
|
|
self.directories.set_included_directory(included_directory, &mut self.text_messages)
|
|
}
|
|
|
|
pub fn set_excluded_directory(&mut self, excluded_directory: Vec<PathBuf>) {
|
|
self.directories.set_excluded_directory(excluded_directory, &mut self.text_messages);
|
|
}
|
|
pub fn set_allowed_extensions(&mut self, allowed_extensions: String) {
|
|
self.allowed_extensions.set_allowed_extensions(allowed_extensions, &mut self.text_messages);
|
|
}
|
|
|
|
pub fn set_excluded_items(&mut self, excluded_items: Vec<String>) {
|
|
self.excluded_items.set_excluded_items(excluded_items, &mut self.text_messages);
|
|
}
|
|
|
|
/// Check files for any with size == 0
|
|
fn check_files(&mut self, stop_receiver: Option<&Receiver<()>>, progress_sender: Option<&futures::channel::mpsc::UnboundedSender<ProgressData>>) -> bool {
|
|
let start_time: SystemTime = SystemTime::now();
|
|
let mut folders_to_check: Vec<PathBuf> = Vec::with_capacity(1024 * 2); // This should be small enough too not see to big difference and big enough to store most of paths without needing to resize vector
|
|
|
|
// Add root folders for finding
|
|
for id in &self.directories.included_directories {
|
|
folders_to_check.push(id.clone());
|
|
}
|
|
|
|
//// PROGRESS THREAD START
|
|
const LOOP_DURATION: u32 = 200; //in ms
|
|
let progress_thread_run = Arc::new(AtomicBool::new(true));
|
|
|
|
let atomic_file_counter = Arc::new(AtomicUsize::new(0));
|
|
|
|
let progress_thread_handle = if let Some(progress_sender) = progress_sender {
|
|
let progress_send = progress_sender.clone();
|
|
let progress_thread_run = progress_thread_run.clone();
|
|
let atomic_file_counter = atomic_file_counter.clone();
|
|
thread::spawn(move || loop {
|
|
progress_send
|
|
.unbounded_send(ProgressData {
|
|
current_stage: 0,
|
|
max_stage: 0,
|
|
files_checked: atomic_file_counter.load(Ordering::Relaxed) as usize,
|
|
})
|
|
.unwrap();
|
|
if !progress_thread_run.load(Ordering::Relaxed) {
|
|
break;
|
|
}
|
|
sleep(Duration::from_millis(LOOP_DURATION as u64));
|
|
})
|
|
} else {
|
|
thread::spawn(|| {})
|
|
};
|
|
//// PROGRESS THREAD END
|
|
|
|
while !folders_to_check.is_empty() {
|
|
if stop_receiver.is_some() && stop_receiver.unwrap().try_recv().is_ok() {
|
|
// End thread which send info to gui
|
|
progress_thread_run.store(false, Ordering::Relaxed);
|
|
progress_thread_handle.join().unwrap();
|
|
return false;
|
|
}
|
|
|
|
let segments: Vec<_> = folders_to_check
|
|
.par_iter()
|
|
.map(|current_folder| {
|
|
let mut dir_result = vec![];
|
|
let mut warnings = vec![];
|
|
let mut fe_result = vec![];
|
|
// Read current dir childrens
|
|
let read_dir = match fs::read_dir(¤t_folder) {
|
|
Ok(t) => t,
|
|
Err(e) => {
|
|
warnings.push(fl!(
|
|
"core_cannot_open_dir",
|
|
generate_translation_hashmap(vec![("dir", current_folder.display().to_string()), ("reason", e.to_string())])
|
|
));
|
|
return (dir_result, warnings, fe_result);
|
|
}
|
|
};
|
|
|
|
// Check every sub folder/file/link etc.
|
|
'dir: for entry in read_dir {
|
|
let entry_data = match entry {
|
|
Ok(t) => t,
|
|
Err(e) => {
|
|
warnings.push(fl!(
|
|
"core_cannot_read_entry_dir",
|
|
generate_translation_hashmap(vec![("dir", current_folder.display().to_string()), ("reason", e.to_string())])
|
|
));
|
|
continue 'dir;
|
|
}
|
|
};
|
|
let metadata: Metadata = match entry_data.metadata() {
|
|
Ok(t) => t,
|
|
Err(e) => {
|
|
warnings.push(fl!(
|
|
"core_cannot_read_metadata_dir",
|
|
generate_translation_hashmap(vec![("dir", current_folder.display().to_string()), ("reason", e.to_string())])
|
|
));
|
|
continue 'dir;
|
|
}
|
|
};
|
|
if metadata.is_dir() {
|
|
if !self.recursive_search {
|
|
continue 'dir;
|
|
}
|
|
|
|
let next_folder = current_folder.join(entry_data.file_name());
|
|
if self.directories.is_excluded(&next_folder) {
|
|
continue 'dir;
|
|
}
|
|
|
|
if self.excluded_items.is_excluded(&next_folder) {
|
|
continue 'dir;
|
|
}
|
|
|
|
dir_result.push(next_folder);
|
|
} else if metadata.is_file() {
|
|
atomic_file_counter.fetch_add(1, Ordering::Relaxed);
|
|
} else if metadata.file_type().is_symlink() {
|
|
atomic_file_counter.fetch_add(1, Ordering::Relaxed);
|
|
|
|
let file_name_lowercase: String = match entry_data.file_name().into_string() {
|
|
Ok(t) => t,
|
|
Err(_inspected) => {
|
|
warnings.push(fl!(
|
|
"core_file_not_utf8_name",
|
|
generate_translation_hashmap(vec![("name", entry_data.path().display().to_string())])
|
|
));
|
|
continue 'dir;
|
|
}
|
|
}
|
|
.to_lowercase();
|
|
|
|
if !self.allowed_extensions.matches_filename(&file_name_lowercase) {
|
|
continue 'dir;
|
|
}
|
|
|
|
let current_file_name = current_folder.join(entry_data.file_name());
|
|
if self.excluded_items.is_excluded(¤t_file_name) {
|
|
continue 'dir;
|
|
}
|
|
|
|
let mut destination_path = PathBuf::new();
|
|
let type_of_error;
|
|
|
|
match current_file_name.read_link() {
|
|
Ok(t) => {
|
|
destination_path.push(t);
|
|
let mut number_of_loop = 0;
|
|
let mut current_path = current_file_name.clone();
|
|
loop {
|
|
if number_of_loop == 0 && !current_path.exists() {
|
|
type_of_error = ErrorType::NonExistentFile;
|
|
break;
|
|
}
|
|
if number_of_loop == MAX_NUMBER_OF_SYMLINK_JUMPS {
|
|
type_of_error = ErrorType::InfiniteRecursion;
|
|
break;
|
|
}
|
|
|
|
current_path = match current_path.read_link() {
|
|
Ok(t) => t,
|
|
Err(_inspected) => {
|
|
// Looks that some next symlinks are broken, but we do nothing with it - TODO why they are broken
|
|
continue 'dir;
|
|
}
|
|
};
|
|
|
|
number_of_loop += 1;
|
|
}
|
|
}
|
|
Err(_inspected) => {
|
|
// Failed to load info about it
|
|
type_of_error = ErrorType::NonExistentFile;
|
|
}
|
|
}
|
|
|
|
// Creating new file entry
|
|
let fe: FileEntry = FileEntry {
|
|
symlink_path: current_file_name.clone(),
|
|
destination_path,
|
|
type_of_error,
|
|
modified_date: match metadata.modified() {
|
|
Ok(t) => match t.duration_since(UNIX_EPOCH) {
|
|
Ok(d) => d.as_secs(),
|
|
Err(_inspected) => {
|
|
warnings.push(fl!(
|
|
"core_file_modified_before_epoch",
|
|
generate_translation_hashmap(vec![("name", current_file_name.display().to_string())])
|
|
));
|
|
0
|
|
}
|
|
},
|
|
Err(e) => {
|
|
warnings.push(fl!(
|
|
"core_file_no_modification_date",
|
|
generate_translation_hashmap(vec![("name", current_file_name.display().to_string()), ("reason", e.to_string())])
|
|
));
|
|
0
|
|
}
|
|
},
|
|
};
|
|
|
|
// Adding files to Vector
|
|
fe_result.push(fe);
|
|
}
|
|
}
|
|
(dir_result, warnings, fe_result)
|
|
})
|
|
.collect();
|
|
|
|
// Advance the frontier
|
|
folders_to_check.clear();
|
|
|
|
// Process collected data
|
|
for (segment, warnings, fe_result) in segments {
|
|
folders_to_check.extend(segment);
|
|
self.text_messages.warnings.extend(warnings);
|
|
for fe in fe_result {
|
|
self.invalid_symlinks.push(fe);
|
|
}
|
|
}
|
|
}
|
|
|
|
self.information.number_of_invalid_symlinks = self.invalid_symlinks.len();
|
|
// End thread which send info to gui
|
|
progress_thread_run.store(false, Ordering::Relaxed);
|
|
progress_thread_handle.join().unwrap();
|
|
|
|
Common::print_time(start_time, SystemTime::now(), "check_files_size".to_string());
|
|
true
|
|
}
|
|
|
|
/// Function to delete files, from filed Vector
|
|
fn delete_files(&mut self) {
|
|
let start_time: SystemTime = SystemTime::now();
|
|
|
|
match self.delete_method {
|
|
DeleteMethod::Delete => {
|
|
for file_entry in &self.invalid_symlinks {
|
|
if fs::remove_file(file_entry.symlink_path.clone()).is_err() {
|
|
self.text_messages.warnings.push(file_entry.symlink_path.display().to_string());
|
|
}
|
|
}
|
|
}
|
|
DeleteMethod::None => {
|
|
//Just do nothing
|
|
}
|
|
}
|
|
|
|
Common::print_time(start_time, SystemTime::now(), "delete_files".to_string());
|
|
}
|
|
}
|
|
|
|
impl Default for InvalidSymlinks {
|
|
fn default() -> Self {
|
|
Self::new()
|
|
}
|
|
}
|
|
|
|
impl DebugPrint for InvalidSymlinks {
|
|
#[allow(dead_code)]
|
|
#[allow(unreachable_code)]
|
|
/// Debugging printing - only available on debug build
|
|
fn debug_print(&self) {
|
|
#[cfg(not(debug_assertions))]
|
|
{
|
|
return;
|
|
}
|
|
println!("---------------DEBUG PRINT---------------");
|
|
println!("### Information's");
|
|
|
|
println!("Errors size - {}", self.text_messages.errors.len());
|
|
println!("Warnings size - {}", self.text_messages.warnings.len());
|
|
println!("Messages size - {}", self.text_messages.messages.len());
|
|
println!("Number of removed files - {}", self.information.number_of_removed_files);
|
|
println!("Number of failed to remove files - {}", self.information.number_of_failed_to_remove_files);
|
|
|
|
println!("### Other");
|
|
|
|
println!("Invalid symlinks list size - {}", self.invalid_symlinks.len());
|
|
println!("Excluded items - {:?}", self.excluded_items.items);
|
|
println!("Included directories - {:?}", self.directories.included_directories);
|
|
println!("Excluded directories - {:?}", self.directories.excluded_directories);
|
|
println!("Recursive search - {}", self.recursive_search);
|
|
println!("Delete Method - {:?}", self.delete_method);
|
|
println!("-----------------------------------------");
|
|
}
|
|
}
|
|
|
|
impl SaveResults for InvalidSymlinks {
|
|
fn save_results_to_file(&mut self, file_name: &str) -> bool {
|
|
let start_time: SystemTime = SystemTime::now();
|
|
let file_name: String = match file_name {
|
|
"" => "results.txt".to_string(),
|
|
k => k.to_string(),
|
|
};
|
|
|
|
let file_handler = match File::create(&file_name) {
|
|
Ok(t) => t,
|
|
Err(e) => {
|
|
self.text_messages.errors.push(format!("Failed to create file {}, reason {}", file_name, e));
|
|
return false;
|
|
}
|
|
};
|
|
let mut writer = BufWriter::new(file_handler);
|
|
|
|
if let Err(e) = writeln!(
|
|
writer,
|
|
"Results of searching {:?} with excluded directories {:?} and excluded items {:?}",
|
|
self.directories.included_directories, self.directories.excluded_directories, self.excluded_items.items
|
|
) {
|
|
self.text_messages.errors.push(format!("Failed to save results to file {}, reason {}", file_name, e));
|
|
return false;
|
|
}
|
|
|
|
if !self.invalid_symlinks.is_empty() {
|
|
writeln!(writer, "Found {} invalid symlinks.", self.information.number_of_invalid_symlinks).unwrap();
|
|
for file_entry in self.invalid_symlinks.iter() {
|
|
writeln!(
|
|
writer,
|
|
"{}\t\t{}\t\t{}",
|
|
file_entry.symlink_path.display(),
|
|
file_entry.destination_path.display(),
|
|
match file_entry.type_of_error {
|
|
ErrorType::InfiniteRecursion => "Infinite Recursion",
|
|
ErrorType::NonExistentFile => "Non Existent File",
|
|
}
|
|
)
|
|
.unwrap();
|
|
}
|
|
} else {
|
|
write!(writer, "Not found any invalid symlinks.").unwrap();
|
|
}
|
|
Common::print_time(start_time, SystemTime::now(), "save_results_to_file".to_string());
|
|
true
|
|
}
|
|
}
|
|
|
|
impl PrintResults for InvalidSymlinks {
|
|
/// Print information's about duplicated entries
|
|
/// Only needed for CLI
|
|
fn print_results(&self) {
|
|
let start_time: SystemTime = SystemTime::now();
|
|
println!("Found {} invalid symlinks.\n", self.information.number_of_invalid_symlinks);
|
|
for file_entry in self.invalid_symlinks.iter() {
|
|
println!(
|
|
"{}\t\t{}\t\t{}",
|
|
file_entry.symlink_path.display(),
|
|
file_entry.destination_path.display(),
|
|
match file_entry.type_of_error {
|
|
ErrorType::InfiniteRecursion => "Infinite Recursion",
|
|
ErrorType::NonExistentFile => "Non Existent File",
|
|
}
|
|
);
|
|
}
|
|
|
|
Common::print_time(start_time, SystemTime::now(), "print_entries".to_string());
|
|
}
|
|
}
|