Class: Roebe::DhcpcdWrapper

Inherits:
Base show all
Defined in:
lib/roebe/classes/dhcpcd/dhcpcd_wrapper.rb

Overview

Roebe::DhcpcdWrapper

Direct Known Subclasses

KillDhcpcd

Constant Summary collapse

DIRECTORY_CONTAINING_THE_PID_OF_DHCPCD =
#

DIRECTORY_CONTAINING_THE_PID_OF_DHCPCD

This is the directory where we may find the .pid of dhcpcd.

#
'/var/run/'
ALL_PIDS =
#

ALL_PIDS

The full name may be ‘dhcpcd-enp5s0.pid’.

#
"#{DIRECTORY_CONTAINING_THE_PID_OF_DHCPCD}dhcpcd*.pid"
KILLALL_DHCPCD =
#

KILLALL_DHCPCD

#
'killall dhcpcd'

Constants inherited from Base

Base::COLOURS, Base::HOME_DIRECTORY_OF_USER_X, Base::N, Base::NAMESPACE

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#actions, #append_this_onto_that_file, #append_what_into, #be_silent, #be_verbose?, #beautiful_url, #burlywood, #call_next, #chdir, #cheerful_guy, #cliner, #complex_esystem, #convert_global_env, #copy_directory, #copy_file, #cornflowerblue, #create_directory, #crimson, #current_month?, #current_time?, #current_year?, #cyan, #darkcyan, #darkgreen, #darkkhaki, #darkslateblue, #deeppink, #delete_symlink, #do_not_use_the_base_colours, #do_use_the_base_colours, #e, #ecomment, #editor_to_use?, #efancy, #eimp, #emphasis, #ensure_main_encoding, #ensure_utf_encoding, #eparse, #erev, #esteelblue, #etomato, #ewarn, #exit_program, #firebrick, #get_current_day, #get_current_month, #get_files_and_directories, #get_files_from, #get_german_name_for_this_weekday, #gold, #green, #grey, #hh_mm_ss, #hh_mm_ss_day_month_year, #home_dir?, #home_directory_of_user_x?, #infer_the_namespace, #internal_hash?, #is_a_directory?, #is_a_file?, #is_a_jpg_file?, #is_an_image_file?, #is_archive?, #is_audio_file?, #is_in_studium_dir?, #is_multimedia_file?, #is_on_roebe?, #is_on_windows?, #is_studium_available?, #is_symlink?, #is_this_a_ruby_file?, #is_video_file?, #iso_encoding?, #le, #left_colour, #lightblue, #lightgreen, #lightseagreen, #lightsteelblue, #lime, #limegreen, #localhost_to_data, #log_directory?, #main_encoding?, #mediumorchid, #mediumpurple, #mediumseagreen, #mediumslateblue, #mediumspringgreen, #mediumturquoise, #mkdir_p, #mv, #n_days_in_this_month, #n_pages_in_this_pdf_file?, #namespace?, #no_file_exists_at, #ogrey, #olive, #olivedrab, #open_in_browser, #opne, #opnesystem, #opnn, #orange, #orchid, #orev, #palegoldenrod, #palevioletred, #pink, #powderblue, #programs_dir?, #project_base_dir?, #random_html_colour, #rds, #read_file_in_iso_encoding, #read_file_via_the_default_encoding, #read_lines_via_iso_encoding, #readlines_with_main_encoding, #red, #register_sigint, #remove, #remove_directory, #remove_file, #rename_kde_konsole_tab, #replace_localhost_with_data, #report_pwd, #require_rescue, #reset_the_internal_hash, #return_all_directories_from_this_directory, #return_all_files_from_this_directory, #return_current_directory, #return_dd_mm_yyyy, #return_file_or_directory_of, #return_files_from_pwd, #return_last_part_of_the_current_directory, #return_utc, #rev, #right_arrow?, #right_colour, #roebe_log_directory?, #rosybrown, #royalblue, #ruby_base_directory?, #run_in_background, #run_rcfiles_then_run_ata_via_qdbus, #sandybrown, #sdir, #seagreen, #set_be_verbose, #set_xorg_buffer, #sfancy, #sfile, #silent_redirection?, #simp, #simple_esystem, #skyblue, #slateblue, #slategray, #springgreen, #steelblue, #string_italic, #swarn, #symlink, #teal, #temp_dir?, #to_camelcase, #to_counted_hash, #tomato, #touch, #try_to_require_the_beautiful_url_gem, #try_to_require_the_html_template, #try_to_require_the_open_gem, #try_to_require_the_program_information_gem, #try_to_require_the_xorg_buffer, #use_colours?, #verbose_truth, #weekday?, #word_wrap, #write_what_into, #yellow

Methods included from Base::CommandlineArguments

#append_onto_the_commandline_arguments, #clear_commandline_arguments, #commandline_arguments?, #commandline_arguments_as_string?, #commandline_arguments_without_leading_hyphens?, #first_argument?, #first_argument_without_leading_hyphens?, #has_an_argument_been_passed?, #remove_hyphened_arguments_from_the_commandline_arguments, #return_commandline_arguments_with_leading_hyphens, #second_argument?, #set_commandline_arguments

Constructor Details

#initialize(commandline_arguments = nil, run_already = true) ⇒ DhcpcdWrapper

#

initialize

#


49
50
51
52
53
54
55
56
57
58
 
# File 'lib/roebe/classes/dhcpcd/dhcpcd_wrapper.rb', line 49

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

#

Roebe::DhcpcdWrapper[]

#


253
254
255
 
# File 'lib/roebe/classes/dhcpcd/dhcpcd_wrapper.rb', line 253

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

Instance Method Details

#do_run_the_default_actions ⇒ Object

#

do_run_the_default_actions

#


213
214
215
216
217
 
# File 'lib/roebe/classes/dhcpcd/dhcpcd_wrapper.rb', line 213

def do_run_the_default_actions
  kill_old_dhcpcd_processes
  purge_old_entries
  start_the_dhcpcd_command
end

#get_matches ⇒ Object

#

get_matches

#


162
163
164
 
# File 'lib/roebe/classes/dhcpcd/dhcpcd_wrapper.rb', line 162

def get_matches
  return Dir[ALL_PIDS]
end

#infer_the_target_device ⇒ Object

#

infer_the_target_device

#


120
121
122
 
# File 'lib/roebe/classes/dhcpcd/dhcpcd_wrapper.rb', line 120

def infer_the_target_device
  set_the_target_device(:eth0)
end

#is_dhcpcd_running? ⇒ Boolean

#

is_dhcpcd_running?

This method will query whether dhcpcd is running or not.

#

Returns:

  • (Boolean) 


129
130
131
132
 
# File 'lib/roebe/classes/dhcpcd/dhcpcd_wrapper.rb', line 129

def is_dhcpcd_running?
  result = `ps ax #{ERROR_LINE}`
  result.include? ' dhcpcd' # We must exclude 'ruby_dhcpcd' here.
end

#kill_the_old_dhcpcd_processes ⇒ Object Also known as: kill_old_dhcpcd_processes, kill_dhcpcd, try_to_kill_dhcpcd

#

kill_the_old_dhcpcd_processes

This method will kill any running dhcpcd process.

#


151
152
153
154
155
 
# File 'lib/roebe/classes/dhcpcd/dhcpcd_wrapper.rb', line 151

def kill_the_old_dhcpcd_processes
  if is_dhcpcd_running?
    esystem(KILLALL_DHCPCD) { :do_colourize_and_pad_the_system_command }
  end
end

#menu(i = commandline_arguments? ) ⇒ Object

#

menu (menu tag)

#


230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/roebe/classes/dhcpcd/dhcpcd_wrapper.rb', line 230

def menu(
    i = commandline_arguments?
  )
  if i.is_a? Array
    if i.empty?
      show_help
    else
      i.each {|entry| menu(entry) }
    end
  else
    case i # case tag
    # ===================================================================== #
    # === mydhcpcd --help
    # ===================================================================== #
    when /help$/i
      show_help
    end
  end
end

#process_id_of_dhcpcd? ⇒ Boolean

#

process_id_of_dhcpcd?

This method will yield the process-id of dhcpcd; or “unknown” if dhcpcd is not running.

#

Returns:

  • (Boolean) 


96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/roebe/classes/dhcpcd/dhcpcd_wrapper.rb', line 96

def process_id_of_dhcpcd?
  result = `ps ax #{ERROR_LINE}`
  result = result.split(N).select {|line|
    line.include?('dhcpcd: ')
  }
  if result and result.is_a?(Array)
    result = result.first
    if result.is_a?(String) and result.include?(' ')
      return result.split(' ').first.to_s
    end
  end
  return 'unknown' # Default return value.
end

#purge_old_entries(matches = get_matches) ⇒ Object

#

purge_old_entries

#


198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/roebe/classes/dhcpcd/dhcpcd_wrapper.rb', line 198

def purge_old_entries(
    matches = get_matches
  )
  matches.each {|entry|
    if File.exist? entry
      opne "#{rev}Purging the old entry at `#{sfile(entry)}"\
           "#{rev}` (Filesize: #{sfancy(File.size(entry).to_s)}#{rev})#{rev}."
      delete(entry)
    end
  }
end

#reset ⇒ Object

#

reset (reset tag)

#


63
64
65
66
67
 
# File 'lib/roebe/classes/dhcpcd/dhcpcd_wrapper.rb', line 63

def reset
  super()
  infer_the_namespace
  infer_the_target_device
end

#run ⇒ Object

#

run (run tag)

#


222
223
224
225
 
# File 'lib/roebe/classes/dhcpcd/dhcpcd_wrapper.rb', line 222

def run
  menu
  do_run_the_default_actions
end

#set_the_target_device(i = 'enp5s0') ⇒ Object Also known as: set_target_device

#

set_the_target_device

#


79
80
81
82
83
84
85
86
87
88
 
# File 'lib/roebe/classes/dhcpcd/dhcpcd_wrapper.rb', line 79

def set_the_target_device(
    i = 'enp5s0'
  )
  i = i.join(' ').strip if i.is_a? Array
  if i.is_a?(String) and i.frozen?
    i = i.dup
  end
  i.tr!('ß','0') if i.is_a?(String) and i.include?('ß')
  @internal_hash[:the_target_device] = i.to_sym
end

#show_help ⇒ Object

#

show_help (help tag)

#


169
170
171
172
173
 
# File 'lib/roebe/classes/dhcpcd/dhcpcd_wrapper.rb', line 169

def show_help
  e
  e 'No help options are documented so far for this class.'
  e
end

#start_the_dhcpcd_command(i = target_device? ) ⇒ Object Also known as: start_dhcpcd

#

start_the_dhcpcd_command (start tag)

This method will start the actual dhcpcd command.

The argument that should be passed to this method is the actual target device, such as ‘enp5s0’.

#


183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/roebe/classes/dhcpcd/dhcpcd_wrapper.rb', line 183

def start_the_dhcpcd_command(
    i = target_device?
  )
  opne "#{rev}Now starting the #{steelblue('dhcpcd')} #{rev}command "\
       "at #{sfancy(i)}#{rev}."
  _ = "  dhcpcd #{i}"
  e
  e steelblue(_)
  e
  system _
end

#the_target_device? ⇒ Boolean Also known as: target_device?

#

the_target_device?

#

Returns:

  • (Boolean) 


72
73
74
 
# File 'lib/roebe/classes/dhcpcd/dhcpcd_wrapper.rb', line 72

def the_target_device?
  @internal_hash[:the_target_device]
end

#use_enp5s0 ⇒ Object

#

use_enp5s0

#


113
114
115
 
# File 'lib/roebe/classes/dhcpcd/dhcpcd_wrapper.rb', line 113

def use_enp5s0
  set_the_target_device('enp5s0') # Hardcoded default works fine here.
end

#verbose_is_dhcpcd_running? ⇒ Boolean

#

verbose_is_dhcpcd_running?

#

Returns:

  • (Boolean) 


137
138
139
140
141
142
143
144
 
# File 'lib/roebe/classes/dhcpcd/dhcpcd_wrapper.rb', line 137

def verbose_is_dhcpcd_running?
  case is_dhcpcd_running?
  when true
    opne 'dhcpcd is currently running.'
  when false
    opne 'dhcpcd is currently NOT running.'
  end
end