2020-09-27 21:31:14 +13:00
use std ::fs ::{ File , Metadata } ;
use std ::io ::prelude ::* ;
2020-10-15 05:41:37 +13:00
use std ::path ::PathBuf ;
2020-12-02 22:25:27 +13:00
use std ::time ::{ Duration , SystemTime , UNIX_EPOCH } ;
use std ::{ fs , thread } ;
2020-09-27 21:31:14 +13:00
use crate ::common ::Common ;
use crate ::common_directory ::Directories ;
use crate ::common_items ::ExcludedItems ;
use crate ::common_messages ::Messages ;
use crate ::common_traits ::* ;
2020-10-10 22:15:20 +13:00
use crossbeam_channel ::Receiver ;
2020-12-02 22:25:27 +13:00
use std ::sync ::atomic ::{ AtomicBool , AtomicUsize , Ordering } ;
use std ::sync ::Arc ;
use std ::thread ::sleep ;
#[ derive(Debug) ]
pub struct ProgressData {
pub current_stage : u8 ,
pub max_stage : u8 ,
pub files_checked : usize ,
}
2020-09-27 21:31:14 +13:00
#[ derive(Eq, PartialEq, Clone, Debug) ]
pub enum DeleteMethod {
None ,
Delete ,
}
#[ derive(Clone) ]
pub struct FileEntry {
2020-10-15 05:41:37 +13:00
pub path : PathBuf ,
2020-10-01 17:53:10 +13:00
pub modified_date : u64 ,
2020-09-27 21:31:14 +13:00
}
/// Info struck with helpful information's about results
2020-10-10 09:32:08 +13:00
#[ derive(Default) ]
2020-09-27 21:31:14 +13:00
pub struct Info {
pub number_of_checked_files : usize ,
pub number_of_checked_folders : usize ,
pub number_of_ignored_files : usize ,
pub number_of_ignored_things : usize ,
pub number_of_temporary_files : usize ,
pub number_of_removed_files : usize ,
pub number_of_failed_to_remove_files : usize ,
}
impl Info {
2020-10-10 09:32:08 +13:00
pub fn new ( ) -> Self {
Default ::default ( )
2020-09-27 21:31:14 +13:00
}
}
/// Struct with required information's to work
pub struct Temporary {
text_messages : Messages ,
information : Info ,
temporary_files : Vec < FileEntry > ,
directories : Directories ,
excluded_items : ExcludedItems ,
recursive_search : bool ,
delete_method : DeleteMethod ,
2020-10-10 22:15:20 +13:00
stopped_search : bool ,
2020-09-27 21:31:14 +13:00
}
impl Temporary {
2020-10-10 09:32:08 +13:00
pub fn new ( ) -> Self {
Self {
2020-09-27 21:31:14 +13:00
text_messages : Messages ::new ( ) ,
information : Info ::new ( ) ,
recursive_search : true ,
directories : Directories ::new ( ) ,
excluded_items : ExcludedItems ::new ( ) ,
delete_method : DeleteMethod ::None ,
temporary_files : vec ! [ ] ,
2020-10-10 22:15:20 +13:00
stopped_search : false ,
2020-09-27 21:31:14 +13:00
}
}
/// Finding temporary files, save results to internal struct variables
2020-12-02 22:25:27 +13:00
pub fn find_temporary_files ( & mut self , stop_receiver : Option < & Receiver < ( ) > > , progress_sender : Option < & futures ::channel ::mpsc ::Sender < ProgressData > > ) {
2020-09-27 21:31:14 +13:00
self . directories . optimize_directories ( self . recursive_search , & mut self . text_messages ) ;
2020-12-02 22:25:27 +13:00
if ! self . check_files ( stop_receiver , progress_sender ) {
2020-10-10 22:15:20 +13:00
self . stopped_search = true ;
return ;
}
2020-09-27 21:31:14 +13:00
self . delete_files ( ) ;
self . debug_print ( ) ;
}
2020-10-10 22:15:20 +13:00
pub fn get_stopped_search ( & self ) -> bool {
self . stopped_search
}
2020-09-27 21:31:14 +13:00
2020-10-10 09:32:08 +13:00
pub const fn get_temporary_files ( & self ) -> & Vec < FileEntry > {
2020-10-02 06:26:25 +13:00
& self . temporary_files
}
2020-10-10 09:32:08 +13:00
pub const fn get_text_messages ( & self ) -> & Messages {
2020-09-27 21:31:14 +13:00
& self . text_messages
}
2020-10-10 09:32:08 +13:00
pub const fn get_information ( & self ) -> & Info {
2020-09-27 21:31:14 +13:00
& 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 : String ) -> bool {
self . directories . set_included_directory ( included_directory , & mut self . text_messages )
}
pub fn set_excluded_directory ( & mut self , excluded_directory : String ) {
self . directories . set_excluded_directory ( excluded_directory , & mut self . text_messages ) ;
}
pub fn set_excluded_items ( & mut self , excluded_items : String ) {
self . excluded_items . set_excluded_items ( excluded_items , & mut self . text_messages ) ;
}
2020-12-02 22:25:27 +13:00
fn check_files ( & mut self , stop_receiver : Option < & Receiver < ( ) > > , progress_sender : Option < & futures ::channel ::mpsc ::Sender < ProgressData > > ) -> bool {
2020-09-27 21:31:14 +13: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
2020-09-27 21:31:14 +13:00
// Add root folders for finding
for id in & self . directories . included_directories {
2020-10-15 05:41:37 +13:00
folders_to_check . push ( id . clone ( ) ) ;
2020-09-27 21:31:14 +13:00
}
self . information . number_of_checked_folders + = folders_to_check . len ( ) ;
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_file_counter = Arc ::new ( AtomicUsize ::new ( 0 ) ) ;
let progress_thread_handle ;
if let Some ( progress_sender ) = progress_sender {
let mut progress_send = progress_sender . clone ( ) ;
let progress_thread_run = progress_thread_run . clone ( ) ;
let atomic_file_counter = atomic_file_counter . clone ( ) ;
progress_thread_handle = thread ::spawn ( move | | loop {
progress_send
. try_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 {
progress_thread_handle = thread ::spawn ( | | { } ) ;
}
//// PROGRESS THREAD END
2020-09-27 21:31:14 +13: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-09-27 21:31:14 +13:00
2020-10-15 05:41:37 +13:00
let current_folder = folders_to_check . pop ( ) . unwrap ( ) ;
2020-09-27 21:31:14 +13:00
// Read current dir, if permission are denied just go to next
let read_dir = match fs ::read_dir ( & current_folder ) {
Ok ( t ) = > t ,
Err ( _ ) = > {
2020-10-15 05:41:37 +13:00
self . text_messages . warnings . push ( format! ( " Cannot open dir {} " , current_folder . display ( ) ) ) ;
2020-09-27 21:31:14 +13:00
continue ;
} // Permissions denied
} ;
// Check every sub folder/file/link etc.
2020-10-10 09:32:08 +13:00
' dir : for entry in read_dir {
2020-09-27 21:31:14 +13:00
let entry_data = match entry {
Ok ( t ) = > t ,
Err ( _ ) = > {
2020-10-15 05:41:37 +13:00
self . text_messages . warnings . push ( format! ( " Cannot read entry in dir {} " , current_folder . display ( ) ) ) ;
2020-09-27 21:31:14 +13:00
continue ;
} //Permissions denied
} ;
let metadata : Metadata = match entry_data . metadata ( ) {
Ok ( t ) = > t ,
Err ( _ ) = > {
2020-10-15 05:41:37 +13:00
self . text_messages . warnings . push ( format! ( " Cannot read metadata in dir {} " , current_folder . display ( ) ) ) ;
2020-09-27 21:31:14 +13:00
continue ;
} //Permissions denied
} ;
if metadata . is_dir ( ) {
self . information . number_of_checked_folders + = 1 ;
if ! self . recursive_search {
continue ;
}
2020-10-15 05:41:37 +13:00
let next_folder = current_folder . join ( entry_data . file_name ( ) ) ;
if self . directories . is_excluded ( & next_folder ) | | self . excluded_items . is_excluded ( & next_folder ) {
continue 'dir ;
2020-09-27 21:31:14 +13:00
}
2020-10-15 05:41:37 +13:00
2020-10-10 09:32:08 +13:00
folders_to_check . push ( next_folder ) ;
2020-09-27 21:31:14 +13:00
} else if metadata . is_file ( ) {
2020-12-02 22:25:27 +13:00
atomic_file_counter . fetch_add ( 1 , Ordering ::Relaxed ) ;
2020-10-07 04:10:34 +13:00
let file_name_lowercase : String = match entry_data . file_name ( ) . into_string ( ) {
Ok ( t ) = > t ,
Err ( _ ) = > continue ,
}
. to_lowercase ( ) ;
2020-09-27 21:31:14 +13:00
// Temporary files which needs to have dot in name(not sure if exists without dot)
2020-10-02 08:29:40 +13:00
let temporary_with_dot = [ " # " , " thumbs.db " , " .bak " , " ~ " , " .tmp " , " .temp " , " .ds_store " , " .crdownload " , " .part " , " .cache " , " .dmp " , " .download " , " .partial " ] ;
2020-09-27 21:31:14 +13:00
2020-10-10 09:32:08 +13:00
if ! file_name_lowercase . contains ( '.' ) | | ! temporary_with_dot . iter ( ) . any ( | f | file_name_lowercase . ends_with ( f ) ) {
self . information . number_of_ignored_files + = 1 ;
continue 'dir ;
2020-09-27 21:31:14 +13:00
}
// Checking files
2020-10-15 05:41:37 +13:00
let current_file_name = current_folder . join ( entry_data . file_name ( ) ) ;
if self . excluded_items . is_excluded ( & current_file_name ) {
continue 'dir ;
2020-10-11 02:18:04 +13:00
}
2020-10-10 09:32:08 +13:00
// Creating new file entry
let fe : FileEntry = FileEntry {
path : current_file_name . clone ( ) ,
modified_date : match metadata . modified ( ) {
Ok ( t ) = > match t . duration_since ( UNIX_EPOCH ) {
Ok ( d ) = > d . as_secs ( ) ,
2020-09-27 21:31:14 +13:00
Err ( _ ) = > {
2020-10-15 05:41:37 +13:00
self . text_messages . warnings . push ( format! ( " File {} seems to be modified before Unix Epoch. " , current_file_name . display ( ) ) ) ;
2020-10-10 09:32:08 +13:00
0
}
2020-09-27 21:31:14 +13:00
} ,
2020-10-10 09:32:08 +13:00
Err ( _ ) = > {
2020-10-15 05:41:37 +13:00
self . text_messages . warnings . push ( format! ( " Unable to get modification date from file {} " , current_file_name . display ( ) ) ) ;
2020-10-10 09:32:08 +13:00
continue ;
} // Permissions Denied
} ,
} ;
2020-09-27 21:31:14 +13:00
2020-10-10 09:32:08 +13:00
// Adding files to Vector
self . temporary_files . push ( fe ) ;
2020-09-27 21:31:14 +13:00
2020-10-10 09:32:08 +13:00
self . information . number_of_checked_files + = 1 ;
2020-09-27 21:31:14 +13:00
} else {
// Probably this is symbolic links so we are free to ignore this
self . information . number_of_ignored_things + = 1 ;
}
}
}
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 21:31:14 +13:00
self . information . number_of_temporary_files = self . temporary_files . len ( ) ;
Common ::print_time ( start_time , SystemTime ::now ( ) , " check_files_size " . to_string ( ) ) ;
2020-10-10 22:15:20 +13:00
true
2020-09-27 21:31:14 +13:00
}
/// 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 . temporary_files {
if fs ::remove_file ( file_entry . path . clone ( ) ) . is_err ( ) {
2020-10-15 05:41:37 +13:00
self . text_messages . warnings . push ( file_entry . path . display ( ) . to_string ( ) ) ;
2020-09-27 21:31:14 +13:00
}
}
}
DeleteMethod ::None = > {
//Just do nothing
}
}
Common ::print_time ( start_time , SystemTime ::now ( ) , " delete_files " . to_string ( ) ) ;
}
}
impl Default for Temporary {
fn default ( ) -> Self {
Self ::new ( )
}
}
impl DebugPrint for Temporary {
#[ allow(dead_code) ]
#[ allow(unreachable_code) ]
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 checked files - {} " , self . information . number_of_checked_files ) ;
println! ( " Number of checked folders - {} " , self . information . number_of_checked_folders ) ;
println! ( " Number of ignored files - {} " , self . information . number_of_ignored_files ) ;
println! ( " Number of ignored things(like symbolic links) - {} " , self . information . number_of_ignored_things ) ;
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! ( " Temporary list size - {} " , self . temporary_files . 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 . to_string ( ) ) ;
println! ( " Delete Method - {:?} " , self . delete_method ) ;
println! ( " ----------------------------------------- " ) ;
}
}
impl SaveResults for Temporary {
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 mut file = match File ::create ( & file_name ) {
Ok ( t ) = > t ,
Err ( _ ) = > {
self . text_messages . errors . push ( format! ( " Failed to create file {} " , file_name ) ) ;
return false ;
}
} ;
2020-10-15 05:41:37 +13:00
if writeln! (
file ,
" Results of searching {:?} with excluded directories {:?} and excluded items {:?} " ,
self . directories . included_directories , self . directories . excluded_directories , self . excluded_items . items
)
. is_err ( )
{
self . text_messages . errors . push ( format! ( " Failed to save results to file {} " , file_name ) ) ;
return false ;
2020-09-27 21:31:14 +13:00
}
if ! self . temporary_files . is_empty ( ) {
2020-10-15 05:41:37 +13:00
writeln! ( file , " Found {} temporary files. " , self . information . number_of_temporary_files ) . unwrap ( ) ;
2020-09-27 21:31:14 +13:00
for file_entry in self . temporary_files . iter ( ) {
2020-10-15 05:41:37 +13:00
writeln! ( file , " {} " , file_entry . path . display ( ) ) . unwrap ( ) ;
2020-09-27 21:31:14 +13:00
}
} else {
2020-10-15 05:41:37 +13:00
write! ( file , " Not found any temporary files. " ) . unwrap ( ) ;
2020-09-27 21:31:14 +13:00
}
Common ::print_time ( start_time , SystemTime ::now ( ) , " save_results_to_file " . to_string ( ) ) ;
true
}
}
impl PrintResults for Temporary {
fn print_results ( & self ) {
let start_time : SystemTime = SystemTime ::now ( ) ;
println! ( " Found {} temporary files. \n " , self . information . number_of_temporary_files ) ;
for file_entry in self . temporary_files . iter ( ) {
2020-10-15 05:41:37 +13:00
println! ( " {} " , file_entry . path . display ( ) ) ;
2020-09-27 21:31:14 +13:00
}
Common ::print_time ( start_time , SystemTime ::now ( ) , " print_entries " . to_string ( ) ) ;
}
}