Class: RBT::RemoveSymlinks

Inherits:
Base show all
Defined in:
lib/rbt/utility_scripts/remove_symlinks.rb

Overview

Constant Summary collapse

DEFAULT_MODE =
#

DEFAULT_MODE

#
:gobolinux_mode
SHALL_WE_CREATE_MISSING_DIRECTORIES =
#

SHALL_WE_CREATE_MISSING_DIRECTORIES

This may create missing directories.

#
false
ARRAY_DIRECTORIES_TO_CHECK =
#

ARRAY_DIRECTORIES_TO_CHECK

#
[
  RBT.syslib_directory?,
  RBT.sysbin_directory?,
  "#{RBT.syslib_directory?}pkgconfig/",
  RBT.sysinclude_directory?,
  RBT.sysshare_directory?
]

Constants inherited from LeanPrototype

LeanPrototype::ALL_COLOUR_METHODS, LeanPrototype::ARRAY_KDE_KONSOLE_COLOURS_IN_USE, LeanPrototype::DAY_NAMES, LeanPrototype::NAMESPACE, LeanPrototype::SILENT_REDIRECTION

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#cat, #cd_back_to_the_current_working_directory, #consider_reporting_how_many_programs_are_registered, #cookbook_files?, #copy_recursively, #delete_code_of_conduct?, #determine_appdir_prefix_from_this_input, #directory_validation?, #do_not_show_names, #fast_return_file_size_of_this_program, #file_last_symlinked_program?, #file_programs_version_url, #gem_version, #is_a_64bit_system?, #is_ccache_available?, #is_porg_available?, #is_this_binary_registered?, #is_this_program_included?, #make_command?, #make_install_command?, #new_cookbook_instance_for, #program_exists?, #publish_list_of_all_programs_version, #rcp, registered_binaries?, #remove_symlink, #rename_kde_konsole_tab, #repackage, #report_n_programs, #report_working_directory, #return_compile_time_statistics, #return_n_random_characters, #return_version_of_this_program, #run_make_then_make_install, #sanitize_url1_entry, #set_source_directory, #show_overview_over_available_utility_scripts, #symlink_all_files_from_this_directory_to_that_directory, #system_tags?, #upload_list_of_all_programs_version, #use_yaml_database_for_tags?, #warn_and_exit, #wget

Methods inherited from LeanPrototype

#a_or_an?, #abbreviations?, #absolute_path, #action, #add_to_the_commandline_arguments, #all_binaries?, #all_files_from, #all_libraries?, #allowed_cookbook_entries?, #appdir_location_of?, #append_onto_the_internal_hash, #append_what_into, #archive_type_of?, #available_programs?, #be_quiet?, #be_verbose?, #begins_with_a_comment?, #capitalize_first_alphabetical_character, #cd_to_the_log_directory, #cd_to_the_temp_directory, #change_directory, #change_permission, #cheering_person?, #chmod, #chop_off_archive, #clear_commandline_arguments, #cliner, #coloured_and_padded_e, #coloured_and_padded_esystem, #coloured_esystem, #colourize_directory_for_system_results, #colourize_this_error, #colourize_this_file_path, #colourize_this_warning, #commandline_arguments?, #commandline_arguments_without_hyphens?, #comment, #convert_dd_mm_yyyy_to_its_long_variant, #convert_env_variable, #copy_directory, #copy_files, #cpr, #create_directory, #current_hour?, #dd_mmm_yyy, #debug, #debug?, #directory_expanded_cookbooks?, #disable_colours, #display_md5sum?, #do_not_debug, #does_the_cookbook_include_this_program?, #does_this_expanded_cookbook_file_exist_for_this_program?, #does_this_file_exist?, #does_this_file_exist_and_is_it_a_file?, #e, #eblue, #ecomment, #ecrimson, #edir, #editor?, #efancy, #eimp, #enable_colours, #enable_debug, #ensure_main_encoding_for, #eparse, #esystem, #esystem_gold, #etomato, #ewarn, #exit_program, #expanded_cookbooks_directory_exists?, #extract_this_archive, #extract_to?, #file_compiled_programs?, #file_dirname_retaining_trailing_slash, #file_predefined_installation_instructions?, #file_specification_of_registered_cookbook_entries, #find_cookbook_alias_for, #find_this_yaml_file, #first_argument?, #first_non_hyphen_argument?, #get_all_directories_from, #get_all_files_from, #get_all_programs, #get_date, #get_extended_date, #get_files_and_directories_from, #go_to_base_dir, #home_dir?, #host_system?, #infer_the_namespace, #internal_hash?, #internal_hash_set_commandline_arguments, #is_an_archive?, #is_directory?, #is_file?, #is_github_url?, #is_make_available?, #is_meson_installed?, #is_on_gobolinux?, #is_on_windows?, #is_roebe?, #is_superuser?, #is_symlink?, #is_this_a_header?, #is_this_a_library?, #is_this_program_included?, #iso_encoding?, #load_dataset_from_this_expanded_cookbook, #load_yaml, #load_yaml_file_from_the_cookbook_directory_for_this_program, #log_directory?, #main_encoding?, #meson_build_file_exists?, #months?, #move_file, #n_programs_are_available?, #n_programs_available?, #namespace?, #no_directory_exists_at, #no_directory_was_found_at, #no_opn, #no_such_file_exists, #open_in_browser, #open_in_editor, #opncomment, #opne, #opnef, #opnerev, #opnerror, #opnesystem, #opnewarn, #opnfancy, #opnn, #otomato, #packages_directory?, #path_to_this_expanded_cookbooks_dataset, #pkgconfig_directory?, #populate_the_internal_hash_with_default_values, #predefined_installation_instructions?, #prepend_this_commandline_argument, #program_version_of?, #project_base_directory?, #project_yaml_directory?, #query_path?, #rarrow?, #read_file, #read_file_in_default_encoding, #read_file_with_default_encoding, #readlines, #readlines_with_proper_encoding, #register_sigint, #registered_cookbook_entries?, #remove, #remove_archive_from_the_end, #remove_comments_from_each_line, #remove_directory, #remove_double_slashes, #remove_file, #remove_newlines, #remove_parens, #remove_symlink, #remove_the_first_commandline_argument, #remove_this_commandline_argument, #remove_this_entry_from_the_commandline_arguments, #remove_trailing_ANSII_escape_code, #remove_unnecessary_data_from_url, #rename, #report_pwd, #require_the_rbt_aliases, #reset_the_internal_hash, #return_all_archives_from_this_directory, #return_appdir_prefix, #return_commandline_arguments_with_leading_hyphens, #return_current_hour_minutes_second, #return_date, #return_day_of_the_month_based_on_utc, #return_full_time, #return_hours_minutes_seconds_based_on_utc, #return_location_to_this_programs_yaml_file, #return_month_based_on_this_number, #return_month_based_on_utc, #return_opnn, #return_program_name, #return_program_name_for_gobolinux_systems, #return_program_name_via_program_information, #return_pwd, #return_unicode_warning_symbol_or_empty_string, #return_utc, #return_utc_time_in_a_format_similar_to_slackware, #return_weekday_based_on_utc, #return_year_based_on_utc, #rev, #rpn, #run_simulation=, #run_simulation?, #sdir, #sdir_return_pwd, #set_be_silent, #set_be_verbose, #set_first_commandline_argument, #set_namespace, #set_use_colours, #set_use_opn, #set_xorg_buffer, #sfancy, #sfile, #silent_redirection?, #silently_create_this_directory_if_it_does_not_yet_exist, #simp, #source_base_directory?, #ssym, #stderr, #store_into_this_directory?, #string_right_arrow?, #swarn, #symlink, #sysbin_directory?, #sysetc_directory?, #sysinclude_directory?, #syslib_directory?, #sysshare_directory?, #system_directory?, #temp_directory?, #to_bool, #to_camelcase, #to_iso_encoding, #to_unicode, #today?, #touch, #try_to_require_beautiful_url, #try_to_require_the_environment_information_gem, #try_to_require_the_extracter_gem, #try_to_require_the_open_gem, #try_to_require_the_xorg_buffer, #try_to_require_wget, #try_to_return_a_special_compile_component, #unicode_cliner, #unicode_middle_cliner, #use_colours=, #use_colours?, #use_opn=, #use_opn?, #utf_encoding?, #verbose_truth, #word_wrap, #write_what_into, #write_what_into_via_unicode, #yes_or_no

Constructor Details

#initialize(mode = :gobolinux_mode, run_already = true) ⇒ RemoveSymlinks

#

initialize

#


55
56
57
58
59
60
61
62
 
# File 'lib/rbt/utility_scripts/remove_symlinks.rb', line 55

def initialize(
    mode        = :gobolinux_mode,
    run_already = true
  )
  reset
  set_mode(mode)
  run if run_already
end

Class Method Details

.[](i = '') ⇒ Object

#
#


288
289
290
 
# File 'lib/rbt/utility_scripts/remove_symlinks.rb', line 288

def self.[](i = '')
  new(i)
end

Instance Method Details

#consider_using_other_directories ⇒ Object

#

consider_using_other_directories

#


178
179
180
181
182
183
 
# File 'lib/rbt/utility_scripts/remove_symlinks.rb', line 178

def consider_using_other_directories
  case @mode
  when 'HERE','PWD','pwd' # This allows us to work on the current directory instead.
    @array_directories_to_check[0,0] = return_pwd
  end unless File.exist? @mode
end

#get_all_symlinks_from(i = return_pwd, be_verbose = true) ⇒ Object

#

This method will fetch and then return all symlinks from a given directory.

#


142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/rbt/utility_scripts/remove_symlinks.rb', line 142

def get_all_symlinks_from(
    i = return_pwd, be_verbose = true
  )
  set_base_dir(i)
  _ = Dir["#{@base_dir}*"].reject {|file| ! File.symlink? file}
  if be_verbose
    opne "#{rev}There are #{sfancy(_.size.to_s.rjust(3))} "\
         "#{rev}symlinks listed in #{sdir(i)}#{rev}."
  end
  return _
end

#notify_the_user_how_many_symlinks_were_removed ⇒ Object

#
#


157
158
159
160
161
162
163
 
# File 'lib/rbt/utility_scripts/remove_symlinks.rb', line 157

def notify_the_user_how_many_symlinks_were_removed
  _ = @array_remove_these_broken_symlinks
  unless _.empty?
    opne "#{rev}We were able to remove "\
         "#{orange(_.size.to_s)} #{rev}non-existing symlinks."
  end
end

#process_each_directory(i = @array_directories_to_check) ⇒ Object

#

process_each_directory

#


105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/rbt/utility_scripts/remove_symlinks.rb', line 105

def process_each_directory(
    i = @array_directories_to_check
  )
  unless i.is_a? Array
    i = [i]
  end 
  i.each {|entry|
    unless File.exist? entry
      if SHALL_WE_CREATE_MISSING_DIRECTORIES
        opnwarn "#{rev}#{swarn('The directory `')}"\
                "#{sdir(entry)}#{swarn('` does not exist.')}"
        opnwarn 'Thus, we will create it now.'
        create_directory(entry)
      end
    end
    # ===================================================================== #
    # Next, obtain all symlinks from the target.
    # ===================================================================== #
    _ = get_all_symlinks_from(entry)
    _.each {|inner_entry|
      if File.exist? inner_entry # File exist, this is good, passthrough.
      else # The file does not exist, so register it for removal.
        # e 'FILE DOES NOT EXIST '+sfile(inner_entry)
        opne "#{sfile(inner_entry)}#{rev} does not exist."
        opne "#{rev}→ Thus we delete `#{sfile(inner_entry)}#{rev}`."
        register_broken_symlink_for_removal(inner_entry) # First register, then delete.
      end
    }
  }
end

#register_broken_symlink_for_removal(i) ⇒ Object

#
#


96
97
98
99
100
 
# File 'lib/rbt/utility_scripts/remove_symlinks.rb', line 96

def register_broken_symlink_for_removal(i)
  unless @array_remove_these_broken_symlinks.include? i # Do not include duplicates.
    @array_remove_these_broken_symlinks << i
  end
end

#remove_all_symlinks(these_entries = , be_verbose = :be_quiet) ⇒ Object Also known as: remove_these_symlinks

#

This method will remove all symlinks in the current directory.

Invocation examples:

remove_symlinks --remove-all-symlinks
remove_symlinks --pwd
#


265
266
267
268
269
270
271
 
# File 'lib/rbt/utility_scripts/remove_symlinks.rb', line 265

def remove_all_symlinks(
    these_entries = Dir['*'],
    be_verbose    = :be_quiet
  )
  _ = these_entries.select {|entry| File.symlink? entry }
  delete_symlink(_, be_verbose)
end

#remove_broken_symlinks ⇒ Object

#
#


206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/rbt/utility_scripts/remove_symlinks.rb', line 206

def remove_broken_symlinks
  if @array_remove_these_broken_symlinks.empty?
    opne 'We did not find any broken symlinks on the system. '\
         'This is good!'
  else
    @array_remove_these_broken_symlinks.each {|this_symlink|
      # =================================================================== #
      # The reason we handle it in this class is so that we
      # can use opnn() on each removed symlink.
      # =================================================================== #
      opnn; delete_symlink(this_symlink, :be_verbose)
    }
  end
end

#remove_empty_directories ⇒ Object

#

remove_empty_directories

#


168
169
170
171
172
173
 
# File 'lib/rbt/utility_scripts/remove_symlinks.rb', line 168

def remove_empty_directories
  # ======================================================================= #
  # Delegate towards class RBT::RemoveEmptyDirectories next:
  # ======================================================================= #
  RemoveEmptyDirectories.new
end

#reset ⇒ Object

#

reset

#


67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/rbt/utility_scripts/remove_symlinks.rb', line 67

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @array_directories_to_check
  # ======================================================================= #
  @array_directories_to_check = ARRAY_DIRECTORIES_TO_CHECK
  # ======================================================================= #
  # === @array_remove_these_broken_symlinks
  # ======================================================================= #
  @array_remove_these_broken_symlinks = []
  # ======================================================================= #
  # === :be_verbose
  # ======================================================================= #
  set_be_quiet
end

#run ⇒ Object Also known as: start, default

#

run (run tag)

#


276
277
278
279
280
281
282
 
# File 'lib/rbt/utility_scripts/remove_symlinks.rb', line 276

def run
  consider_using_other_directories
  remove_empty_directories
  process_each_directory
  remove_broken_symlinks
  notify_the_user_how_many_symlinks_were_removed
end

#set_base_dir(i) ⇒ Object

#

set_base_dir

#


87
88
89
90
91
 
# File 'lib/rbt/utility_scripts/remove_symlinks.rb', line 87

def set_base_dir(i)
  i = rds(i)
  i << '/' unless i.end_with? '/' # We require a trailing '/' here.
  @base_dir = i
end

#set_mode(i = DEFAULT_MODE) ⇒ Object

#

set_mode

Not yet sure if we need this.

#


226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/rbt/utility_scripts/remove_symlinks.rb', line 226

def set_mode(
    i = DEFAULT_MODE
  )
  if i.is_a? Array
    i = i.first
  end
  i = DEFAULT_MODE if i.nil?
  case i # case tag
  # ======================================================================= #
  # === remove_symlinks --pwd
  #
  # This entry point will use the current working directory as our
  # input-base.
  # ======================================================================= #
  when /^-?-?pwd$/,
       /^-?-?remove(-|_)?all(-|_)?symlinks$/
    remove_these_symlinks(Dir['*'], :be_verbose)
    exit
  # ======================================================================= #
  # === remove_symlinks --help
  # ======================================================================= #
  when /^-?-?help$/
    show_help
    exit
  end
  @mode = i.to_s # Will be guaranteed to be a String.
end

#show_help ⇒ Object

#

show_help (help tag)

To invoke this method, try:

remove_symlinks --help
#


193
194
195
196
197
198
199
200
201
 
# File 'lib/rbt/utility_scripts/remove_symlinks.rb', line 193

def show_help
  opnn { :no_trailing_character }
  e
  e
  e '  --remove-all-symlinks # Remove all symlinks in '\
    'the current directory.'
  e '  --pwd                 # ^^^ an alias to the above'
  e
end