2020-09-22 21:24:55 +12:00
use std ::collections ::BTreeMap ;
2022-01-04 06:13:07 +13:00
use std ::fs ;
use std ::fs ::File ;
2021-01-09 23:52:43 +13:00
use std ::io ::{ BufWriter , Write } ;
2022-01-04 06:13:07 +13:00
use std ::path ::PathBuf ;
2023-05-03 22:44:28 +12:00
2021-11-28 08:49:20 +13:00
use crossbeam_channel ::Receiver ;
2023-05-03 08:37:12 +12:00
use futures ::channel ::mpsc ::UnboundedSender ;
2021-11-28 08:49:20 +13:00
2022-01-04 06:13:07 +13:00
use crate ::common_dir_traversal ::{ Collect , DirTraversalBuilder , DirTraversalResult , FolderEmptiness , FolderEntry , ProgressData } ;
2021-11-28 08:49:20 +13:00
use crate ::common_directory ::Directories ;
use crate ::common_items ::ExcludedItems ;
use crate ::common_messages ::Messages ;
use crate ::common_traits ::{ DebugPrint , PrintResults , SaveResults } ;
2020-09-01 05:37:30 +12:00
2020-09-27 04:16:12 +13:00
/// Struct to store most basics info about all folder
2020-09-01 05:37:30 +12:00
pub struct EmptyFolder {
2020-09-18 20:23:49 +12:00
information : Info ,
2020-09-18 17:32:37 +12:00
delete_folders : bool ,
2020-09-18 20:23:49 +12:00
text_messages : Messages ,
2020-11-01 07:19:33 +13:00
excluded_items : ExcludedItems ,
2020-10-15 05:41:37 +13:00
empty_folder_list : BTreeMap < PathBuf , FolderEntry > , // Path, FolderEntry
2020-09-27 03:52:13 +13:00
directories : Directories ,
2020-10-10 22:15:20 +13:00
stopped_search : bool ,
2020-09-01 05:37:30 +12:00
}
2020-09-18 17:32:37 +12:00
/// Info struck with helpful information's about results
2020-10-10 09:32:08 +13:00
#[ derive(Default) ]
2020-09-18 17:32:37 +12:00
pub struct Info {
2020-09-22 21:24:55 +12:00
pub number_of_empty_folders : usize ,
2020-09-18 17:32:37 +12:00
}
2021-11-28 08:57:10 +13:00
2020-09-18 17:32:37 +12:00
impl Info {
2023-01-29 06:54:02 +13:00
#[ must_use ]
2020-10-10 09:32:08 +13:00
pub fn new ( ) -> Self {
Default ::default ( )
2020-09-18 17:32:37 +12:00
}
}
2023-01-29 06:54:02 +13:00
/// Method implementation for `EmptyFolder`
2020-09-01 05:37:30 +12:00
impl EmptyFolder {
2020-09-02 08:48:20 +12:00
/// New function providing basics values
2023-01-29 06:54:02 +13:00
#[ must_use ]
2020-10-10 09:32:08 +13:00
pub fn new ( ) -> Self {
Self {
2020-09-18 20:23:49 +12:00
information : Default ::default ( ) ,
2020-09-18 17:32:37 +12:00
delete_folders : false ,
2020-09-27 03:52:13 +13:00
text_messages : Messages ::new ( ) ,
2020-11-01 07:19:33 +13:00
excluded_items : Default ::default ( ) ,
2020-09-02 03:10:54 +12:00
empty_folder_list : Default ::default ( ) ,
2020-09-27 03:52:13 +13:00
directories : Directories ::new ( ) ,
2020-10-10 22:15:20 +13:00
stopped_search : false ,
2020-09-01 05:37:30 +12:00
}
}
2023-01-29 06:54:02 +13:00
#[ must_use ]
2020-10-10 22:15:20 +13:00
pub fn get_stopped_search ( & self ) -> bool {
self . stopped_search
}
2023-01-29 06:54:02 +13:00
#[ must_use ]
2020-10-15 05:41:37 +13:00
pub const fn get_empty_folder_list ( & self ) -> & BTreeMap < PathBuf , FolderEntry > {
2020-09-22 21:24:55 +12:00
& self . empty_folder_list
}
2023-01-29 06:54:02 +13:00
#[ must_use ]
2020-10-10 09:32:08 +13:00
pub const fn get_text_messages ( & self ) -> & Messages {
2020-09-18 20:23:49 +12:00
& self . text_messages
2020-09-18 17:32:37 +12:00
}
2023-01-29 06:54:02 +13:00
#[ must_use ]
2020-10-10 09:32:08 +13:00
pub const fn get_information ( & self ) -> & Info {
2020-09-22 21:24:55 +12:00
& self . information
}
2020-09-18 17:32:37 +12:00
2022-04-24 06:21:46 +12:00
#[ cfg(target_family = " unix " ) ]
pub fn set_exclude_other_filesystems ( & mut self , exclude_other_filesystems : bool ) {
self . directories . set_exclude_other_filesystems ( exclude_other_filesystems ) ;
}
2022-07-20 05:09:52 +12:00
#[ cfg(not(target_family = " unix " )) ]
pub fn set_exclude_other_filesystems ( & mut self , _exclude_other_filesystems : bool ) { }
2022-04-24 06:21:46 +12:00
2021-01-11 08:44:10 +13:00
pub fn set_excluded_items ( & mut self , excluded_items : Vec < String > ) {
2020-11-01 07:19:33 +13:00
self . excluded_items . set_excluded_items ( excluded_items , & mut self . text_messages ) ;
}
2021-01-11 08:44:10 +13:00
pub fn set_excluded_directory ( & mut self , excluded_directory : Vec < PathBuf > ) {
2020-11-01 07:19:33 +13:00
self . directories . set_excluded_directory ( excluded_directory , & mut self . text_messages ) ;
}
2020-09-02 08:48:20 +12:00
/// Public function used by CLI to search for empty folders
2023-05-03 08:37:12 +12:00
pub fn find_empty_folders ( & mut self , stop_receiver : Option < & Receiver < ( ) > > , progress_sender : Option < & UnboundedSender < ProgressData > > ) {
2020-09-27 03:52:13 +13:00
self . directories . optimize_directories ( true , & mut self . text_messages ) ;
2020-12-02 22:25:27 +13:00
if ! self . check_for_empty_folders ( stop_receiver , progress_sender ) {
2020-10-10 22:15:20 +13:00
self . stopped_search = true ;
return ;
}
2020-09-02 03:10:54 +12:00
self . optimize_folders ( ) ;
2020-09-18 17:32:37 +12:00
if self . delete_folders {
2020-09-01 05:37:30 +12:00
self . delete_empty_folders ( ) ;
}
2020-09-18 17:32:37 +12:00
self . debug_print ( ) ;
}
pub fn set_delete_folder ( & mut self , delete_folder : bool ) {
self . delete_folders = delete_folder ;
2020-09-01 05:37:30 +12:00
}
2020-09-02 03:10:54 +12:00
/// 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 ) {
2020-10-15 05:41:37 +13:00
let mut new_directory_folders : BTreeMap < PathBuf , FolderEntry > = Default ::default ( ) ;
2020-09-02 03:10:54 +12:00
2020-09-27 07:46:35 +13:00
for ( name , folder_entry ) in & self . empty_folder_list {
2020-09-27 06:51:28 +13:00
match & folder_entry . parent_path {
2020-09-02 03:10:54 +12:00
Some ( t ) = > {
if ! self . empty_folder_list . contains_key ( t ) {
2020-09-27 06:51:28 +13:00
new_directory_folders . insert ( name . clone ( ) , folder_entry . clone ( ) ) ;
2020-09-02 03:10:54 +12:00
}
}
None = > {
2020-09-27 06:51:28 +13:00
new_directory_folders . insert ( name . clone ( ) , folder_entry . clone ( ) ) ;
2020-09-02 03:10:54 +12:00
}
}
}
self . empty_folder_list = new_directory_folders ;
2020-09-18 21:11:08 +12:00
self . information . number_of_empty_folders = self . empty_folder_list . len ( ) ;
2020-09-02 03:10:54 +12:00
}
2020-09-02 08:48:20 +12:00
/// Function to check if folder are empty.
2023-01-29 06:54:02 +13:00
/// Parameter `initial_checking` for second check before deleting to be sure that checked folder is still empty
2023-05-03 08:37:12 +12:00
fn check_for_empty_folders ( & mut self , stop_receiver : Option < & Receiver < ( ) > > , progress_sender : Option < & UnboundedSender < ProgressData > > ) -> bool {
2022-01-04 06:13:07 +13:00
let result = DirTraversalBuilder ::new ( )
. root_dirs ( self . directories . included_directories . clone ( ) )
. group_by ( | _fe | ( ) )
. stop_receiver ( stop_receiver )
. progress_sender ( progress_sender )
. directories ( self . directories . clone ( ) )
. excluded_items ( self . excluded_items . clone ( ) )
. collect ( Collect ::EmptyFolders )
. max_stage ( 0 )
. build ( )
. run ( ) ;
match result {
DirTraversalResult ::SuccessFiles { .. } = > {
unreachable! ( )
2020-10-10 22:15:20 +13:00
}
2023-05-03 22:44:28 +12:00
DirTraversalResult ::SuccessFolders { folder_entries , warnings } = > {
2022-01-04 06:13:07 +13:00
// 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 ) ;
2021-12-18 07:29:37 +13:00
}
2020-09-01 09:03:10 +12:00
}
2020-09-27 06:51:28 +13:00
2022-01-04 06:13:07 +13:00
self . text_messages . warnings . extend ( warnings ) ;
true
2020-09-02 03:10:54 +12:00
}
2022-01-04 06:13:07 +13:00
DirTraversalResult ::Stopped = > false ,
2020-09-02 03:10:54 +12:00
}
2020-09-01 09:03:10 +12:00
}
2020-09-02 03:10:54 +12:00
2020-09-12 23:25:23 +12:00
/// Deletes earlier found empty folders
2020-09-27 06:51:28 +13:00
fn delete_empty_folders ( & mut self ) {
2020-09-02 08:48:20 +12:00
// Folders may be deleted or require too big privileges
2020-09-27 07:46:35 +13:00
for name in self . empty_folder_list . keys ( ) {
2020-09-27 06:51:28 +13:00
match fs ::remove_dir_all ( name ) {
2020-09-02 03:10:54 +12:00
Ok ( _ ) = > ( ) ,
2021-11-15 03:53:55 +13:00
Err ( e ) = > self . text_messages . warnings . push ( format! ( " Failed to remove folder {} , reason {} " , name . display ( ) , e ) ) ,
2020-09-02 03:10:54 +12:00
} ;
}
2020-09-01 09:03:10 +12:00
}
2020-09-02 03:10:54 +12:00
2020-09-27 04:16:12 +13:00
/// Set included dir which needs to be relative, exists etc.
2021-01-11 08:44:10 +13:00
pub fn set_included_directory ( & mut self , included_directory : Vec < PathBuf > ) {
2020-09-27 03:52:13 +13:00
self . directories . set_included_directory ( included_directory , & mut self . text_messages ) ;
}
}
2020-11-01 07:19:33 +13:00
2020-09-27 03:52:13 +13:00
impl Default for EmptyFolder {
fn default ( ) -> Self {
Self ::new ( )
2020-09-01 05:37:30 +12:00
}
2020-09-27 03:52:13 +13:00
}
2020-09-01 05:37:30 +12:00
2020-09-27 03:52:13 +13:00
impl DebugPrint for EmptyFolder {
2020-09-18 21:31:44 +12:00
#[ allow(dead_code) ]
#[ allow(unreachable_code) ]
2020-09-01 05:37:30 +12:00
fn debug_print ( & self ) {
2020-09-18 21:31:44 +12:00
#[ cfg(not(debug_assertions)) ]
2020-09-18 17:32:37 +12:00
{
2020-09-18 21:31:44 +12:00
return ;
2020-09-01 05:37:30 +12:00
}
2020-09-18 21:31:44 +12:00
println! ( " ---------------DEBUG PRINT--------------- " ) ;
println! ( " Number of empty folders - {} " , self . information . number_of_empty_folders ) ;
2020-09-27 03:52:13 +13:00
println! ( " Included directories - {:?} " , self . directories . included_directories ) ;
2020-09-18 21:31:44 +12:00
println! ( " ----------------------------------------- " ) ;
2020-09-01 05:37:30 +12:00
}
2020-09-27 03:52:13 +13:00
}
2021-11-28 08:57:10 +13:00
2020-09-27 03:52:13 +13:00
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 ( ) ,
} ;
2020-09-01 05:37:30 +12:00
2021-01-09 23:52:43 +13:00
let file_handler = match File ::create ( & file_name ) {
2020-09-27 03:52:13 +13:00
Ok ( t ) = > t ,
2021-11-15 03:53:55 +13:00
Err ( e ) = > {
2022-12-21 20:44:26 +13:00
self . text_messages . errors . push ( format! ( " Failed to create file {file_name} , reason {e} " ) ) ;
2020-09-27 03:52:13 +13:00
return false ;
2020-09-01 05:37:30 +12:00
}
2020-09-27 03:52:13 +13:00
} ;
2021-01-09 23:52:43 +13:00
let mut writer = BufWriter ::new ( file_handler ) ;
2020-09-01 05:37:30 +12:00
2021-12-22 06:44:20 +13:00
if let Err ( e ) = writeln! (
writer ,
" Results of searching {:?} with excluded directories {:?} " ,
self . directories . included_directories , self . directories . excluded_directories
) {
2022-12-21 20:44:26 +13:00
self . text_messages . errors . push ( format! ( " Failed to save results to file {file_name} , reason {e} " ) ) ;
2020-10-15 05:41:37 +13:00
return false ;
2020-09-01 05:37:30 +12:00
}
2020-09-27 03:52:13 +13:00
if ! self . empty_folder_list . is_empty ( ) {
2021-12-22 06:44:20 +13:00
writeln! (
writer ,
" -------------------------------------------------Empty folder list------------------------------------------------- "
)
. unwrap ( ) ;
2021-01-09 23:52:43 +13:00
writeln! ( writer , " Found {} empty folders " , self . information . number_of_empty_folders ) . unwrap ( ) ;
2020-09-27 03:52:13 +13:00
for name in self . empty_folder_list . keys ( ) {
2021-01-09 23:52:43 +13:00
writeln! ( writer , " {} " , name . display ( ) ) . unwrap ( ) ;
2020-09-01 05:37:30 +12:00
}
2020-09-27 03:52:13 +13:00
} else {
2021-01-09 23:52:43 +13:00
write! ( writer , " Not found any empty folders. " ) . unwrap ( ) ;
2020-09-01 05:37:30 +12:00
}
2023-05-03 22:44:28 +12:00
2020-09-27 03:52:13 +13:00
true
2020-09-01 05:37:30 +12:00
}
}
2021-11-28 08:57:10 +13:00
2020-09-27 03:52:13 +13:00
impl PrintResults for EmptyFolder {
fn print_results ( & self ) {
if ! self . empty_folder_list . is_empty ( ) {
println! ( " Found {} empty folders " , self . empty_folder_list . len ( ) ) ;
}
2020-09-27 08:50:16 +13:00
for name in self . empty_folder_list . keys ( ) {
2020-10-15 05:41:37 +13:00
println! ( " {} " , name . display ( ) ) ;
2020-09-27 03:52:13 +13:00
}
2020-09-07 19:06:12 +12:00
}
}