use std::collections::BTreeMap; use std::fs; use std::fs::File; use std::io::{BufWriter, Write}; use std::path::PathBuf; use crossbeam_channel::Receiver; use futures::channel::mpsc::UnboundedSender; use log::{debug, info}; use crate::common_dir_traversal::{Collect, DirTraversalBuilder, DirTraversalResult, FolderEmptiness, FolderEntry, ProgressData, ToolType}; use crate::common_tool::{CommonData, CommonToolData}; use crate::common_traits::{DebugPrint, PrintResults, SaveResults}; /// Struct to store most basics info about all folder pub struct EmptyFolder { common_data: CommonToolData, information: Info, delete_folders: bool, empty_folder_list: BTreeMap, // Path, FolderEntry } /// Info struck with helpful information's about results #[derive(Default)] pub struct Info { pub number_of_empty_folders: usize, } /// Method implementation for `EmptyFolder` impl EmptyFolder { /// New function providing basics values pub fn new() -> Self { Self { common_data: CommonToolData::new(ToolType::EmptyFolders), information: Default::default(), delete_folders: false, empty_folder_list: Default::default(), } } pub const fn get_empty_folder_list(&self) -> &BTreeMap { &self.empty_folder_list } pub const fn get_information(&self) -> &Info { &self.information } pub fn find_empty_folders(&mut self, stop_receiver: Option<&Receiver<()>>, progress_sender: Option<&UnboundedSender>) { info!("Starting finding empty folders"); let start_time = std::time::Instant::now(); self.find_empty_folders_internal(stop_receiver, progress_sender); info!("Ended finding empty folders which took {:?}", start_time.elapsed()); } fn find_empty_folders_internal(&mut self, stop_receiver: Option<&Receiver<()>>, progress_sender: Option<&UnboundedSender>) { self.optimize_dirs_before_start(); if !self.check_for_empty_folders(stop_receiver, progress_sender) { self.common_data.stopped_search = true; return; } self.optimize_folders(); if self.delete_folders { self.delete_empty_folders(); } self.debug_print(); } pub fn set_delete_folder(&mut self, delete_folder: bool) { self.delete_folders = delete_folder; } /// Clean directory tree /// If directory contains only 2 empty folders, then this directory should be removed instead two empty folders inside because it will produce another empty folder. fn optimize_folders(&mut self) { let mut new_directory_folders: BTreeMap = Default::default(); for (name, folder_entry) in &self.empty_folder_list { match &folder_entry.parent_path { Some(t) => { if !self.empty_folder_list.contains_key(t) { new_directory_folders.insert(name.clone(), folder_entry.clone()); } } None => { new_directory_folders.insert(name.clone(), folder_entry.clone()); } } } self.empty_folder_list = new_directory_folders; self.information.number_of_empty_folders = self.empty_folder_list.len(); } /// Function to check if folder are empty. /// Parameter `initial_checking` for second check before deleting to be sure that checked folder is still empty fn check_for_empty_folders(&mut self, stop_receiver: Option<&Receiver<()>>, progress_sender: Option<&UnboundedSender>) -> bool { debug!("check_for_empty_folders - start"); let result = DirTraversalBuilder::new() .root_dirs(self.common_data.directories.included_directories.clone()) .group_by(|_fe| ()) .stop_receiver(stop_receiver) .progress_sender(progress_sender) .directories(self.common_data.directories.clone()) .excluded_items(self.common_data.excluded_items.clone()) .collect(Collect::EmptyFolders) .max_stage(0) .build() .run(); debug!("check_for_empty_folders - collected folders to check"); let res = match result { DirTraversalResult::SuccessFiles { .. } => { unreachable!() } DirTraversalResult::SuccessFolders { folder_entries, warnings } => { // We need to set empty folder list #[allow(unused_mut)] // Used is later by Windows build for (mut name, folder_entry) in folder_entries { if folder_entry.is_empty != FolderEmptiness::No { self.empty_folder_list.insert(name, folder_entry); } } self.common_data.text_messages.warnings.extend(warnings); true } DirTraversalResult::Stopped => false, }; debug!("check_for_empty_folders - end"); res } /// Deletes earlier found empty folders fn delete_empty_folders(&mut self) { // Folders may be deleted or require too big privileges for name in self.empty_folder_list.keys() { match fs::remove_dir_all(name) { Ok(()) => (), Err(e) => self .common_data .text_messages .warnings .push(format!("Failed to remove folder {}, reason {}", name.display(), e)), }; } } } impl Default for EmptyFolder { fn default() -> Self { Self::new() } } impl DebugPrint for EmptyFolder { #[allow(dead_code)] #[allow(unreachable_code)] fn debug_print(&self) { #[cfg(not(debug_assertions))] { return; } println!("---------------DEBUG PRINT---------------"); println!("Number of empty folders - {}", self.information.number_of_empty_folders); self.debug_print_common(); println!("-----------------------------------------"); } } impl SaveResults for EmptyFolder { fn save_results_to_file(&mut self, file_name: &str) -> bool { 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.common_data.text_messages.errors.push(format!("Failed to create file {file_name}, reason {e}")); return false; } }; let mut writer = BufWriter::new(file_handler); if let Err(e) = writeln!( writer, "Results of searching {:?} with excluded directories {:?}", self.common_data.directories.included_directories, self.common_data.directories.excluded_directories ) { self.common_data .text_messages .errors .push(format!("Failed to save results to file {file_name}, reason {e}")); return false; } if !self.empty_folder_list.is_empty() { writeln!( writer, "-------------------------------------------------Empty folder list-------------------------------------------------" ) .unwrap(); writeln!(writer, "Found {} empty folders", self.information.number_of_empty_folders).unwrap(); for name in self.empty_folder_list.keys() { writeln!(writer, "{}", name.display()).unwrap(); } } else { write!(writer, "Not found any empty folders.").unwrap(); } true } } impl PrintResults for EmptyFolder { fn print_results(&self) { if !self.empty_folder_list.is_empty() { println!("Found {} empty folders", self.empty_folder_list.len()); } for name in self.empty_folder_list.keys() { println!("{}", name.display()); } } } impl CommonData for EmptyFolder { fn get_cd(&self) -> &CommonToolData { &self.common_data } fn get_cd_mut(&mut self) -> &mut CommonToolData { &mut self.common_data } }