Class: RBT::NotFoundLibraries

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

Overview

RBT::NotFoundLibraries

Constant Summary collapse

NOT_FOUND_STRING =
#

NOT_FOUND_STRING

#
' => not found'

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(commandline_arguments = nil, run_already = true) ⇒ NotFoundLibraries

#

initialize

#


36
37
38
39
40
41
42
43
44
45
 
# File 'lib/rbt/utility_scripts/not_found_libraries.rb', line 36

def initialize(
    commandline_arguments = nil,
    run_already           = true
  )
  reset
  set_commandline_arguments(
    commandline_arguments
  )
  run if run_already
end

Class Method Details

.[](i = ARGV) ⇒ Object

#

RBT::NotFoundLibraries[]

#


229
230
231
 
# File 'lib/rbt/utility_scripts/not_found_libraries.rb', line 229

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

Instance Method Details

#determine_all_binaries_on_this_system ⇒ Object

#

determine_all_binaries_on_this_system

Determine which .sp files exist on this system.

#


77
78
79
80
81
82
83
84
85
 
# File 'lib/rbt/utility_scripts/not_found_libraries.rb', line 77

def determine_all_binaries_on_this_system
  @all_shared_object_libaries = []
  @search_through_these_directories.each {|this_directory|
    @all_shared_object_libaries << Dir["#{this_directory}*"]
  }
  @all_shared_object_libaries.flatten!
  @all_shared_object_libaries.uniq!
  @all_shared_object_libaries.select! {|entry| File.exist? entry }
end

#hash_these_entries_are_missing? ⇒ Boolean Also known as: dataset?

#

hash_these_entries_are_missing?

#

Returns:

  • (Boolean) 


172
173
174
 
# File 'lib/rbt/utility_scripts/not_found_libraries.rb', line 172

def hash_these_entries_are_missing?
  @hash_these_entries_are_missing
end

#menu(i = commandline_arguments? ) ⇒ Object

#

menu (menu tag)

#


127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/rbt/utility_scripts/not_found_libraries.rb', line 127

def menu(
    i = commandline_arguments?
  )
  if i.is_a? Array
    i.each {|entry| menu(entry) }
  else
    case i # case tag
    # ===================================================================== #
    # === missing_libs --dirs?
    # ===================================================================== #
    when /^-?-?dirs\??$/
      show_the_directories_that_will_be_searched
      exit
    # ===================================================================== #
    # === missing_libs --help
    # ===================================================================== #
    when /^-?-?help/
      show_help
      exit
    end
  end
end

#notify_the_user_what_will_be_done_next ⇒ Object

#

notify_the_user_what_will_be_done_next

#


164
165
166
167
 
# File 'lib/rbt/utility_scripts/not_found_libraries.rb', line 164

def notify_the_user_what_will_be_done_next
  opne 'This class will scan for all binaries on this system and'
  opne 'determine whether any shared-libraries are missing.'
end

#report_whether_entries_are_missing_and_which_ones_are_missing ⇒ Object Also known as: report

#

report_whether_entries_are_missing_and_which_ones_are_missing

#


179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/rbt/utility_scripts/not_found_libraries.rb', line 179

def report_whether_entries_are_missing_and_which_ones_are_missing
  _ = @hash_these_entries_are_missing
  if _.empty?
    opne 'No shared-object library appears to be missing. '\
         'This is good. '+gold('\o/')
    e
    opne "#{rev}The following directories were searched:"
    show_the_directories_that_will_be_searched
  else
    opne "#{rev}These entries appear to be #{orange('missing')}#{rev}:"
    _.each {|this_library_is_missing, array_these_binaries_have_problems|
      e rev+'The following binaries refer to this missing .so library: '+orange(
          File.basename(this_library_is_missing)
        )
      array_these_binaries_have_problems.each {|this_binary_has_a_problem|
        e royalblue("    #{this_binary_has_a_problem}")
      }
    }
    save_the_hash_into_a_yaml_file
  end
end

#reset ⇒ Object

#

reset (reset tag)

#


50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/rbt/utility_scripts/not_found_libraries.rb', line 50

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @hash_these_entries_are_missing
  #
  # The next Hash is our main data-structure for this class.
  # ======================================================================= #
  @hash_these_entries_are_missing = {}
  @hash_these_entries_are_missing.default = []
  # ======================================================================= #
  # === @search_through_these_directories
  # ======================================================================= #
  @search_through_these_directories = %w(
    /bin/
    /sbin/
    /usr/bin/
    /usr/local/bin/
    /System/Index/bin/
  )
end

#run ⇒ Object

#

run (run tag)

#


218
219
220
221
222
223
224
 
# File 'lib/rbt/utility_scripts/not_found_libraries.rb', line 218

def run
  menu
  notify_the_user_what_will_be_done_next
  determine_all_binaries_on_this_system
  run_ldd_on_each_discovered_binary
  report_whether_entries_are_missing_and_which_ones_are_missing
end

#run_ldd_on_each_discovered_binary ⇒ Object

#

run_ldd_on_each_discovered_binary

#


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/rbt/utility_scripts/not_found_libraries.rb', line 90

def run_ldd_on_each_discovered_binary
  @all_shared_object_libaries.each {|this_file|
    result = `ldd #{this_file} 2>&1`
    if result.include? NOT_FOUND_STRING
      matches = result.split("\n").select {|inner_entry|
        inner_entry.include? NOT_FOUND_STRING
      }
      these_matches_are_available = matches.map {|most_inner_entry|
        most_inner_entry.sub(/\t/,'')
      }
      these_matches_are_available.each {|match|
        # ================================================================= #
        # Must eliminate a part of this:
        # ================================================================= #
        match.sub!(/ => not found/,'')
        unless @hash_these_entries_are_missing.has_key? match
          @hash_these_entries_are_missing[match] = []
        end
        @hash_these_entries_are_missing[match] << this_file
        @hash_these_entries_are_missing[match].uniq!
      } 
    end
  }
end

#save_the_hash_into_a_yaml_file ⇒ Object

#

save_the_hash_into_a_yaml_file

This method will put the findings into the file called “missing_libraries.yml”.

#


207
208
209
210
211
212
213
 
# File 'lib/rbt/utility_scripts/not_found_libraries.rb', line 207

def save_the_hash_into_a_yaml_file
  what = YAML.dump(@hash_these_entries_are_missing)
  into = "#{rbt_log_dir?}missing_libraries.yml"
  opne "#{rev}Also keeping a log of these files "\
       "into `#{sfile(into)}#{rev}`."
  write_what_into(what, into)
end

#show_help ⇒ Object

#

show_help (help tag)

#


118
119
120
121
122
 
# File 'lib/rbt/utility_scripts/not_found_libraries.rb', line 118

def show_help
  e
  e '  --dirs? # show which directories were searched'
  e
end

#show_the_directories_that_will_be_searched ⇒ Object

#

show_the_directories_that_will_be_searched

#


153
154
155
156
157
158
159
 
# File 'lib/rbt/utility_scripts/not_found_libraries.rb', line 153

def show_the_directories_that_will_be_searched
  e
  @search_through_these_directories.each {|this_directory|
    e sdir("  #{this_directory}")
  }
  e
end