2023-05-03 08:37:12 +12:00
use std ::fs ;
use std ::fs ::{ DirEntry , File , Metadata } ;
2020-09-27 21:31:14 +13:00
use std ::io ::prelude ::* ;
2021-11-28 08:49:20 +13:00
use std ::io ::BufWriter ;
2023-05-03 08:37:12 +12:00
use std ::path ::{ Path , PathBuf } ;
2023-05-08 06:54:05 +12:00
use std ::sync ::atomic ::{ AtomicUsize , Ordering } ;
2021-11-28 08:49:20 +13:00
use std ::sync ::Arc ;
2020-09-27 21:31:14 +13: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 ;
2023-10-05 19:06:47 +13:00
use log ::{ debug , info } ;
2021-12-18 07:29:37 +13:00
use rayon ::prelude ::* ;
2021-11-28 08:49:20 +13:00
2023-05-08 06:54:05 +12:00
use crate ::common ::{ check_folder_children , prepare_thread_handler_common , send_info_and_wait_for_ending_all_threads } ;
2023-05-11 07:27:41 +12:00
use crate ::common_dir_traversal ::{ common_get_entry_data_metadata , common_read_dir , get_lowercase_name , get_modified_time , CheckingMethod , ProgressData , ToolType } ;
2023-10-05 19:06:47 +13:00
use crate ::common_tool ::{ CommonData , CommonToolData } ;
2020-09-27 21:31:14 +13:00
use crate ::common_traits ::* ;
2023-05-03 08:37:12 +12:00
const TEMP_EXTENSIONS : & [ & str ] = & [
" # " ,
" thumbs.db " ,
" .bak " ,
" ~ " ,
" .tmp " ,
" .temp " ,
" .ds_store " ,
" .crdownload " ,
" .part " ,
" .cache " ,
" .dmp " ,
" .download " ,
" .partial " ,
] ;
2020-09-27 21:31:14 +13:00
2023-02-19 22:21:14 +13:00
#[ derive(Eq, PartialEq, Clone, Debug, Copy) ]
2020-09-27 21:31:14 +13:00
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_temporary_files : usize ,
}
2021-11-28 08:57:10 +13:00
2020-09-27 21:31:14 +13:00
/// Struct with required information's to work
pub struct Temporary {
2023-10-05 19:06:47 +13:00
common_data : CommonToolData ,
2020-09-27 21:31:14 +13:00
information : Info ,
temporary_files : Vec < FileEntry > ,
delete_method : DeleteMethod ,
}
impl Temporary {
2020-10-10 09:32:08 +13:00
pub fn new ( ) -> Self {
Self {
2023-10-05 19:06:47 +13:00
common_data : CommonToolData ::new ( ToolType ::TemporaryFiles ) ,
information : Info ::default ( ) ,
2020-09-27 21:31:14 +13:00
delete_method : DeleteMethod ::None ,
temporary_files : vec ! [ ] ,
}
}
2023-10-05 19:06:47 +13:00
fn find_temporary_files_internal ( & mut self , stop_receiver : Option < & Receiver < ( ) > > , progress_sender : Option < & UnboundedSender < ProgressData > > ) {
self . optimize_dirs_before_start ( ) ;
2020-12-02 22:25:27 +13:00
if ! self . check_files ( stop_receiver , progress_sender ) {
2023-10-05 19:06:47 +13:00
self . common_data . stopped_search = true ;
2020-10-10 22:15:20 +13:00
return ;
}
2020-09-27 21:31:14 +13:00
self . delete_files ( ) ;
self . debug_print ( ) ;
}
2022-04-24 06:21:46 +12:00
2023-10-05 19:06:47 +13:00
pub fn find_temporary_files ( & mut self , stop_receiver : Option < & Receiver < ( ) > > , progress_sender : Option < & UnboundedSender < ProgressData > > ) {
info! ( " Starting finding temporary files " ) ;
let start_time = std ::time ::Instant ::now ( ) ;
self . find_temporary_files_internal ( stop_receiver , progress_sender ) ;
info! ( " Ended finding temporary files which took {:?} " , start_time . elapsed ( ) ) ;
2020-09-27 21:31:14 +13:00
}
2023-05-03 08:37:12 +12:00
fn check_files ( & mut self , stop_receiver : Option < & Receiver < ( ) > > , progress_sender : Option < & UnboundedSender < ProgressData > > ) -> bool {
2023-10-05 19:06:47 +13:00
debug! ( " check_files - start " ) ;
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
2023-10-05 19:06:47 +13:00
for id in & self . common_data . 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
}
2023-05-11 07:27:41 +12:00
let ( progress_thread_handle , progress_thread_run , atomic_counter , _check_was_stopped ) =
2023-10-05 19:06:47 +13:00
prepare_thread_handler_common ( progress_sender , 0 , 0 , 0 , CheckingMethod ::None , self . common_data . tool_type ) ;
2020-12-02 22:25:27 +13:00
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 ( ) {
2023-05-03 08:37:12 +12:00
send_info_and_wait_for_ending_all_threads ( & progress_thread_run , progress_thread_handle ) ;
2020-10-10 22:15:20 +13:00
return false ;
}
2020-09-27 21:31:14 +13:00
2021-12-18 07:29:37 +13:00
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! [ ] ;
2023-05-03 08:37:12 +12:00
let Some ( read_dir ) = common_read_dir ( current_folder , & mut warnings ) else {
return ( dir_result , warnings , fe_result ) ;
2021-12-18 07:29:37 +13:00
} ;
2020-10-11 02:18:04 +13:00
2021-12-18 07:29:37 +13:00
// Check every sub folder/file/link etc.
2023-05-03 08:37:12 +12:00
for entry in read_dir {
let Some ( ( entry_data , metadata ) ) = common_get_entry_data_metadata ( & entry , & mut warnings , current_folder ) else {
continue ;
2021-12-18 07:29:37 +13:00
} ;
2023-05-03 08:37:12 +12:00
if metadata . is_dir ( ) {
check_folder_children (
& mut dir_result ,
& mut warnings ,
current_folder ,
entry_data ,
2023-10-05 19:06:47 +13:00
self . common_data . recursive_search ,
& self . common_data . directories ,
& self . common_data . excluded_items ,
2023-05-03 08:37:12 +12:00
) ;
2021-12-18 07:29:37 +13:00
} else if metadata . is_file ( ) {
2023-05-03 08:37:12 +12:00
if let Some ( file_entry ) = self . get_file_entry ( & metadata , & atomic_counter , entry_data , & mut warnings , current_folder ) {
fe_result . push ( file_entry ) ;
2021-12-18 07:29:37 +13:00
}
}
}
( 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 ) ;
2023-10-05 19:06:47 +13:00
self . common_data . text_messages . warnings . extend ( warnings ) ;
2021-12-18 07:29:37 +13:00
for fe in fe_result {
2020-10-10 09:32:08 +13:00
self . temporary_files . push ( fe ) ;
2020-09-27 21:31:14 +13:00
}
}
}
2021-12-18 07:29:37 +13:00
2023-05-03 08:37:12 +12:00
send_info_and_wait_for_ending_all_threads ( & progress_thread_run , progress_thread_handle ) ;
2020-09-27 21:31:14 +13:00
self . information . number_of_temporary_files = self . temporary_files . len ( ) ;
2023-10-05 19:06:47 +13:00
debug! ( " check_files - end " ) ;
2020-10-10 22:15:20 +13:00
true
2020-09-27 21:31:14 +13:00
}
2023-05-03 08:37:12 +12:00
pub fn get_file_entry (
& self ,
metadata : & Metadata ,
atomic_counter : & Arc < AtomicUsize > ,
entry_data : & DirEntry ,
warnings : & mut Vec < String > ,
current_folder : & Path ,
) -> Option < FileEntry > {
atomic_counter . fetch_add ( 1 , Ordering ::Relaxed ) ;
let Some ( file_name_lowercase ) = get_lowercase_name ( entry_data , warnings ) else {
return None ;
} ;
if ! TEMP_EXTENSIONS . iter ( ) . any ( | f | file_name_lowercase . ends_with ( f ) ) {
return None ;
}
let current_file_name = current_folder . join ( entry_data . file_name ( ) ) ;
2023-10-05 19:06:47 +13:00
if self . common_data . excluded_items . is_excluded ( & current_file_name ) {
2023-05-03 08:37:12 +12:00
return None ;
}
// Creating new file entry
Some ( FileEntry {
path : current_file_name . clone ( ) ,
modified_date : get_modified_time ( metadata , warnings , & current_file_name , false ) ,
} )
}
2020-09-27 21:31:14 +13:00
/// Function to delete files, from filed Vector
fn delete_files ( & mut self ) {
match self . delete_method {
DeleteMethod ::Delete = > {
2023-10-05 19:06:47 +13:00
let mut warnings = Vec ::new ( ) ;
2020-09-27 21:31:14 +13:00
for file_entry in & self . temporary_files {
if fs ::remove_file ( file_entry . path . clone ( ) ) . is_err ( ) {
2023-10-05 19:06:47 +13:00
warnings . push ( file_entry . path . display ( ) . to_string ( ) ) ;
2020-09-27 21:31:14 +13:00
}
}
2023-10-05 19:06:47 +13:00
self . common_data . text_messages . warnings . extend ( warnings ) ;
2020-09-27 21:31:14 +13:00
}
DeleteMethod ::None = > {
//Just do nothing
}
}
}
}
2021-11-28 08:57:10 +13:00
2020-09-27 21:31:14 +13:00
impl SaveResults for Temporary {
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 ( ) ,
} ;
2021-01-09 23:52:43 +13:00
let file_handler = match File ::create ( & file_name ) {
2020-09-27 21:31:14 +13:00
Ok ( t ) = > t ,
2021-11-15 03:53:55 +13:00
Err ( e ) = > {
2023-10-05 19:06:47 +13:00
self . common_data . text_messages . errors . push ( format! ( " Failed to create file {file_name} , reason {e} " ) ) ;
2020-09-27 21:31:14 +13:00
return false ;
}
} ;
2021-01-09 23:52:43 +13:00
let mut writer = BufWriter ::new ( file_handler ) ;
2020-09-27 21:31:14 +13:00
2021-11-15 03:53:55 +13:00
if let Err ( e ) = writeln! (
2021-01-09 23:52:43 +13:00
writer ,
2020-10-15 05:41:37 +13:00
" Results of searching {:?} with excluded directories {:?} and excluded items {:?} " ,
2023-10-05 19:06:47 +13:00
self . common_data . directories . included_directories , self . common_data . directories . excluded_directories , self . common_data . excluded_items . items
2021-11-15 03:53:55 +13:00
) {
2023-10-05 19:06:47 +13:00
self . common_data
. 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-27 21:31:14 +13:00
}
if ! self . temporary_files . is_empty ( ) {
2021-01-09 23:52:43 +13:00
writeln! ( writer , " Found {} temporary files. " , self . information . number_of_temporary_files ) . unwrap ( ) ;
2023-01-29 06:54:02 +13:00
for file_entry in & self . temporary_files {
2021-01-09 23:52:43 +13:00
writeln! ( writer , " {} " , file_entry . path . display ( ) ) . unwrap ( ) ;
2020-09-27 21:31:14 +13:00
}
} else {
2021-01-09 23:52:43 +13:00
write! ( writer , " Not found any temporary files. " ) . unwrap ( ) ;
2020-09-27 21:31:14 +13:00
}
2023-05-08 06:54:05 +12:00
2020-09-27 21:31:14 +13:00
true
}
}
2021-11-28 08:57:10 +13:00
2020-09-27 21:31:14 +13:00
impl PrintResults for Temporary {
fn print_results ( & self ) {
println! ( " Found {} temporary files. \n " , self . information . number_of_temporary_files ) ;
2023-01-29 06:54:02 +13:00
for file_entry in & self . temporary_files {
2020-10-15 05:41:37 +13:00
println! ( " {} " , file_entry . path . display ( ) ) ;
2020-09-27 21:31:14 +13:00
}
}
}
2023-10-05 19:06:47 +13:00
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! ( " ### Information's " ) ;
println! ( " Temporary list size - {} " , self . temporary_files . len ( ) ) ;
println! ( " Delete Method - {:?} " , self . delete_method ) ;
self . debug_print_common ( ) ;
}
}
impl CommonData for Temporary {
fn get_cd ( & self ) -> & CommonToolData {
& self . common_data
}
fn get_cd_mut ( & mut self ) -> & mut CommonToolData {
& mut self . common_data
}
}
impl Temporary {
pub const fn get_temporary_files ( & self ) -> & Vec < FileEntry > {
& self . temporary_files
}
pub const fn get_information ( & self ) -> & Info {
& self . information
}
pub fn set_delete_method ( & mut self , delete_method : DeleteMethod ) {
self . delete_method = delete_method ;
}
}