Class: Roebe::SetHardwareClock

Inherits:
Base show all
Defined in:
lib/roebe/classes/time/set_hardware_clock.rb

Overview

Roebe::SetHardwareClock

Constant Summary

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, #show_help, #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) ⇒ SetHardwareClock

#

initialize

#


39
40
41
42
43
44
45
46
47
48
# File 'lib/roebe/classes/time/set_hardware_clock.rb', line 39

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

Class Method Details

.[](i = '') ⇒ Object

#

Roebe::SetHardwareClock[]

#


150
151
152
# File 'lib/roebe/classes/time/set_hardware_clock.rb', line 150

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

Instance Method Details

#do_parse_the_commandline_arguments_without_leading_hyphens(i = commandline_arguments_without_leading_hyphens? ) ⇒ Object

#

do_parse_the_commandline_arguments

#


116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
# File 'lib/roebe/classes/time/set_hardware_clock.rb', line 116

def do_parse_the_commandline_arguments_without_leading_hyphens(
    i = commandline_arguments_without_leading_hyphens?
  )
  # ======================================================================= #
  # Next we must convert the input into something that makes sense.
  #
  # We typically have input that looks like this:
  #
  #   ["14.11.2020", "17:55:01"]
  #
  # For a "raw" use of hwclok, the following could be used:
  #
  #   hwclock --set --date 11/14/2020 # First comes the month, then the day, and the year.
  #   hwclock --set --date "11/14/2020 19:30:00"
  #
  # For a commandline use of this file, try:
  #
  #   sethardwareclock 14.11.2020 20:57:01
  #
  # ======================================================================= #
  use_this_as_dd_mm_yyyy      = i.first
  splitted                    = use_this_as_dd_mm_yyyy.split('.')
  use_this_as_dd_mm_yyyy      = splitted[1]+'/'+splitted[0]+'/'+splitted[2]
  use_this_as_hh_mm_ss_format = i[1]
  cmd = "hwclock --set --date \"11/14/2020 #{use_this_as_hh_mm_ss_format}\""
  esystem(cmd) { :steelblue }
  if @automatically_sync_the_hardware_clock_onto_the_local_clock
    esystem('hwclock -s')  { :steelblue }
  end
end
#

menu (menu tag)

#


65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
# File 'lib/roebe/classes/time/set_hardware_clock.rb', line 65

def menu(
    i = commandline_arguments?
  )
  if i.is_a? Array
    i.each {|entry| menu(entry) }
  else
    case i # case tag
    # ===================================================================== #
    # The next variant will set a specific date, defaulting to 
    # "12:00:00 AM", that is like so:
    #
    #   hwclock --set --date 8/11/2013
    #
    # ===================================================================== #
    # ===================================================================== #
    # === set_hardware_clock --set-hardware-clock-to-the-system-clock
    #
    # This will take the system-clock, and pass it towards the hardware
    # clock. Thus, system-time will be used as sync towards the
    # BIOS clock.
    # ===================================================================== #
    when /^-?-?set(-|_| )?hardware(-|_| )?clock(-|_| )?to(-|_| )?the(-|_| )?system(-|_| )?clock/,
         /^-?-?copy(-|_| )?system(-|_| )?time$/,
         /^-?-?use(-|_| )?system(-|_| )?time$/,
         /^-?-?sync$/,
         /^-?-?systohc$/ # This stands short for "system to hardware clock".
      esystem 'hwclock -w'
      exit
    end
  end
end

#resetObject

#

reset (reset tag)

#


53
54
55
56
57
58
59
60
# File 'lib/roebe/classes/time/set_hardware_clock.rb', line 53

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @automatically_sync_the_hardware_clock_onto_the_local_clock
  # ======================================================================= #
  @automatically_sync_the_hardware_clock_onto_the_local_clock = true
end

#runObject

#

run (run tag)

#


100
101
102
103
104
105
106
107
108
109
110
111
# File 'lib/roebe/classes/time/set_hardware_clock.rb', line 100

def run
  menu
  _ = first_argument_without_leading_hyphens?
  if _.nil? or _.empty?
    # ===================================================================== #
    # This is run when the user has not given any arguments to this class.
    # ===================================================================== #
    esystem('hwclock') {{ colour: :steelblue }}
  else
    do_parse_the_commandline_arguments_without_leading_hyphens
  end
end