2020-09-27 03:52:13 +13:00
use crate ::common ::Common ;
use crate ::common_directory ::Directories ;
2020-11-01 07:19:33 +13:00
use crate ::common_items ::ExcludedItems ;
2020-09-27 03:52:13 +13:00
use crate ::common_messages ::Messages ;
use crate ::common_traits ::{ DebugPrint , PrintResults , SaveResults } ;
2020-10-10 22:15:20 +13:00
use crossbeam_channel ::Receiver ;
2020-09-22 21:24:55 +12:00
use std ::collections ::BTreeMap ;
2020-09-18 20:23:49 +12:00
use std ::fs ::{ File , Metadata } ;
2021-01-09 23:52:43 +13:00
use std ::io ::{ BufWriter , Write } ;
2021-03-28 01:14:02 +13:00
use std ::path ::{ Path , PathBuf } ;
2020-12-02 22:25:27 +13:00
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 } ;
#[ derive(Debug) ]
pub struct ProgressData {
pub current_stage : u8 ,
pub max_stage : u8 ,
pub folders_checked : usize ,
}
2020-09-01 09:03:10 +12:00
2020-09-02 08:48:20 +12:00
/// Enum with values which show if folder is empty.
2020-09-27 06:51:28 +13:00
/// In function "optimize_folders" automatically "Maybe" is changed to "Yes", so it is not necessary to put it here
2020-09-02 03:10:54 +12:00
#[ derive(Eq, PartialEq, Copy, Clone) ]
2020-09-01 09:03:10 +12:00
enum FolderEmptiness {
No ,
Maybe ,
}
2020-09-02 03:10:54 +12:00
2020-09-02 08:48:20 +12:00
/// Struct assigned to each checked folder with parent path(used to ignore parent if children are not empty) and flag which shows if folder is empty
2020-09-02 03:10:54 +12:00
#[ derive(Clone) ]
2020-09-22 21:24:55 +12:00
pub struct FolderEntry {
2020-10-15 05:41:37 +13:00
parent_path : Option < PathBuf > , // Usable only when finding
2020-09-01 09:03:10 +12:00
is_empty : FolderEmptiness ,
2020-10-01 17:53:10 +13:00
pub modified_date : u64 ,
2020-09-01 09:03:10 +12:00
}
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
}
impl Info {
2020-10-10 09:32:08 +13:00
pub fn new ( ) -> Self {
Default ::default ( )
2020-09-18 17:32:37 +12:00
}
}
2020-09-02 08:48:20 +12: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
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
}
}
2020-10-10 22:15:20 +13:00
pub fn get_stopped_search ( & self ) -> bool {
self . stopped_search
}
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
}
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
}
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
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
2021-04-14 18:23:59 +12:00
pub fn find_empty_folders ( & mut self , stop_receiver : Option < & Receiver < ( ) > > , progress_sender : Option < & futures ::channel ::mpsc ::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.
/// Parameter initial_checking for second check before deleting to be sure that checked folder is still empty
2021-04-14 18:23:59 +12:00
fn check_for_empty_folders ( & mut self , stop_receiver : Option < & Receiver < ( ) > > , progress_sender : Option < & futures ::channel ::mpsc ::UnboundedSender < ProgressData > > ) -> bool {
2020-09-01 09:03:10 +12:00
let start_time : SystemTime = SystemTime ::now ( ) ;
2020-10-15 05:41:37 +13:00
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
let mut folders_checked : BTreeMap < PathBuf , FolderEntry > = Default ::default ( ) ;
2020-09-01 09:03:10 +12:00
2020-12-02 22:25:27 +13:00
//// PROGRESS THREAD START
const LOOP_DURATION : u32 = 200 ; //in ms
let progress_thread_run = Arc ::new ( AtomicBool ::new ( true ) ) ;
let atomic_folder_counter = Arc ::new ( AtomicUsize ::new ( 0 ) ) ;
let progress_thread_handle ;
if let Some ( progress_sender ) = progress_sender {
2021-04-14 18:23:59 +12:00
let progress_send = progress_sender . clone ( ) ;
2020-12-02 22:25:27 +13:00
let progress_thread_run = progress_thread_run . clone ( ) ;
let atomic_folder_counter = atomic_folder_counter . clone ( ) ;
progress_thread_handle = thread ::spawn ( move | | loop {
progress_send
2021-04-14 18:23:59 +12:00
. unbounded_send ( ProgressData {
2020-12-02 22:25:27 +13:00
current_stage : 0 ,
max_stage : 0 ,
folders_checked : atomic_folder_counter . load ( Ordering ::Relaxed ) as usize ,
} )
. unwrap ( ) ;
if ! progress_thread_run . load ( Ordering ::Relaxed ) {
break ;
}
sleep ( Duration ::from_millis ( LOOP_DURATION as u64 ) ) ;
} ) ;
} else {
progress_thread_handle = thread ::spawn ( | | { } ) ;
}
//// PROGRESS THREAD END
2020-10-10 22:15:20 +13:00
// Add root folders for finding
for id in & self . directories . included_directories {
folders_checked . insert (
id . clone ( ) ,
FolderEntry {
parent_path : None ,
is_empty : FolderEmptiness ::Maybe ,
modified_date : 0 ,
} ,
) ;
folders_to_check . push ( id . clone ( ) ) ;
2020-09-01 09:03:10 +12:00
}
while ! folders_to_check . is_empty ( ) {
2020-11-05 06:15:06 +13:00
if stop_receiver . is_some ( ) & & stop_receiver . unwrap ( ) . try_recv ( ) . is_ok ( ) {
2020-12-02 22:25:27 +13:00
// End thread which send info to gui
progress_thread_run . store ( false , Ordering ::Relaxed ) ;
progress_thread_handle . join ( ) . unwrap ( ) ;
2020-10-10 22:15:20 +13:00
return false ;
}
2020-10-15 05:41:37 +13:00
let current_folder = folders_to_check . pop ( ) . unwrap ( ) ;
2020-09-27 06:51:28 +13:00
// Checked folder may be deleted or we may not have permissions to open it so we assume that this folder is not be empty
2020-09-01 09:03:10 +12:00
let read_dir = match fs ::read_dir ( & current_folder ) {
Ok ( t ) = > t ,
2020-09-27 06:51:28 +13:00
Err ( _ ) = > {
2020-09-01 09:03:10 +12:00
folders_checked . get_mut ( & current_folder ) . unwrap ( ) . is_empty = FolderEmptiness ::No ;
continue ;
}
} ;
2020-09-02 08:48:20 +12:00
2020-11-01 07:19:33 +13:00
' dir : for entry in read_dir {
2020-09-10 07:32:23 +12:00
let entry_data = match entry {
2020-09-08 03:39:16 +12:00
Ok ( t ) = > t ,
2020-11-01 07:19:33 +13:00
Err ( _ ) = > {
set_as_not_empty_folder ( & mut folders_checked , & current_folder ) ;
continue 'dir ;
} //Permissions denied
2020-09-10 07:32:23 +12:00
} ;
let metadata : Metadata = match entry_data . metadata ( ) {
2020-09-08 03:39:16 +12:00
Ok ( t ) = > t ,
2020-11-01 07:19:33 +13:00
Err ( _ ) = > {
set_as_not_empty_folder ( & mut folders_checked , & current_folder ) ;
continue 'dir ;
} //Permissions denied
2020-09-08 03:39:16 +12:00
} ;
2020-09-02 08:48:20 +12:00
// If child is dir, still folder may be considered as empty if all children are only directories.
2020-09-01 09:03:10 +12:00
if metadata . is_dir ( ) {
2020-12-02 22:25:27 +13:00
atomic_folder_counter . fetch_add ( 1 , Ordering ::Relaxed ) ;
2020-10-15 05:41:37 +13:00
let next_folder = current_folder . join ( entry_data . file_name ( ) ) ;
2020-11-01 07:19:33 +13:00
if self . excluded_items . is_excluded ( & next_folder ) | | self . directories . is_excluded ( & next_folder ) {
set_as_not_empty_folder ( & mut folders_checked , & current_folder ) ;
continue 'dir ;
}
2020-09-18 20:23:49 +12:00
folders_to_check . push ( next_folder . clone ( ) ) ;
folders_checked . insert (
next_folder . clone ( ) ,
FolderEntry {
2020-12-02 22:25:27 +13:00
parent_path : Some ( current_folder . clone ( ) ) ,
2020-09-18 20:23:49 +12:00
is_empty : FolderEmptiness ::Maybe ,
2020-09-22 21:24:55 +12:00
modified_date : match metadata . modified ( ) {
2020-10-03 04:59:46 +13:00
Ok ( t ) = > match t . duration_since ( UNIX_EPOCH ) {
Ok ( d ) = > d . as_secs ( ) ,
Err ( _ ) = > {
2020-10-15 05:41:37 +13:00
self . text_messages . warnings . push ( format! ( " Folder {} seems to be modified before Unix Epoch. " , current_folder . display ( ) ) ) ;
2020-10-03 04:59:46 +13:00
0
}
} ,
2020-09-22 21:24:55 +12:00
Err ( _ ) = > {
2020-10-15 05:41:37 +13:00
self . text_messages . warnings . push ( format! ( " Failed to read modification date of folder {} " , current_folder . display ( ) ) ) ;
2020-11-01 07:19:33 +13:00
// Can't read data, so assuming that is not empty
set_as_not_empty_folder ( & mut folders_checked , & current_folder ) ;
continue 'dir ;
2020-09-22 21:24:55 +12:00
}
} ,
2020-09-18 20:23:49 +12:00
} ,
) ;
2020-09-01 09:03:10 +12:00
} else {
2020-11-01 07:19:33 +13:00
set_as_not_empty_folder ( & mut folders_checked , & current_folder )
2020-09-01 09:03:10 +12:00
}
}
}
2020-12-02 22:25:27 +13:00
// End thread which send info to gui
progress_thread_run . store ( false , Ordering ::Relaxed ) ;
progress_thread_handle . join ( ) . unwrap ( ) ;
2020-09-27 06:51:28 +13:00
2020-10-10 22:15:20 +13:00
// We need to set empty folder list
2020-10-11 02:18:04 +13:00
#[ allow(unused_mut) ] // Used is later by Windows build
for ( mut name , folder_entry ) in folders_checked {
2020-10-10 22:15:20 +13:00
if folder_entry . is_empty ! = FolderEmptiness ::No {
self . empty_folder_list . insert ( name , folder_entry ) ;
2020-09-02 03:10:54 +12:00
}
}
Common ::print_time ( start_time , SystemTime ::now ( ) , " check_for_empty_folder " . to_string ( ) ) ;
2020-10-10 22:15:20 +13:00
true
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 03:10:54 +12:00
let start_time : SystemTime = SystemTime ::now ( ) ;
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 ( _ ) = > ( ) ,
2020-10-15 05:41:37 +13:00
Err ( _ ) = > self . text_messages . warnings . push ( format! ( " Failed to remove folder {} " , name . display ( ) ) ) ,
2020-09-02 03:10:54 +12:00
} ;
}
Common ::print_time ( start_time , SystemTime ::now ( ) , " delete_files " . to_string ( ) ) ;
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
2021-03-28 01:14:02 +13:00
fn set_as_not_empty_folder ( folders_checked : & mut BTreeMap < PathBuf , FolderEntry > , current_folder : & Path ) {
2020-11-01 07:19:33 +13:00
// Not folder so it may be a file or symbolic link so it isn't empty
folders_checked . get_mut ( current_folder ) . unwrap ( ) . is_empty = FolderEmptiness ::No ;
let mut d = folders_checked . get_mut ( current_folder ) . unwrap ( ) ;
// Loop to recursively set as non empty this and all his parent folders
loop {
d . is_empty = FolderEmptiness ::No ;
if d . parent_path ! = None {
let cf = d . parent_path . clone ( ) . unwrap ( ) ;
d = folders_checked . get_mut ( & cf ) . unwrap ( ) ;
} else {
break ;
}
}
}
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
}
impl SaveResults for EmptyFolder {
fn save_results_to_file ( & mut self , file_name : & str ) -> bool {
2020-09-01 05:37:30 +12:00
let start_time : SystemTime = SystemTime ::now ( ) ;
2020-09-27 03:52:13 +13:00
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 ,
Err ( _ ) = > {
self . text_messages . errors . push ( " Failed to create file " . to_string ( ) + file_name . as_str ( ) ) ;
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-01-09 23:52:43 +13:00
if writeln! ( writer , " Results of searching {:?} with excluded directories {:?} " , self . directories . included_directories , self . directories . excluded_directories ) . is_err ( ) {
2020-10-15 05:41:37 +13:00
self . text_messages . errors . push ( " Failed to save results to file " . to_string ( ) + file_name . as_str ( ) ) ;
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-01-09 23:52:43 +13:00
writeln! ( writer , " -------------------------------------------------Empty folder list------------------------------------------------- " ) . unwrap ( ) ;
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
}
2020-09-27 03:52:13 +13:00
Common ::print_time ( start_time , SystemTime ::now ( ) , " save_results_to_file " . to_string ( ) ) ;
true
2020-09-01 05:37:30 +12:00
}
}
2020-09-27 03:52:13 +13:00
impl PrintResults for EmptyFolder {
/// Prints basic info about empty folders // TODO print better
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
}
}