Class: Dvdprofiler2xbmc::CLI

Inherits:
Object
  • Object
show all
Includes:
AppConfig
Defined in:
lib/dvdprofiler2xbmc/views/cli.rb

Overview

Synopsis

The Command Line Interface

Class Method Summary collapse

Methods included from AppConfig

[], []=, default, exist?, load, save, to_s, valid?

Class Method Details

.execute(stdout, arguments = []) ⇒ Object

Synopsis

Here's the main execution loop



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# File 'lib/dvdprofiler2xbmc/views/cli.rb', line 30

def self.execute(stdout, arguments=[])
  exit_code = ExitCode::OK

  # we start a STDOUT logger, but it will be switched after
  # the config files are read if config[:logger_output] is set

  begin
    # trap ^C interrupts and let the app instance cleanly exit any long loops
    Signal.trap("INT") {DvdProfiler2Xbmc.interrupt}

    logger = setup_logger

    # parse the command line
    options = setup_parser()
    od = options.parse(arguments)
    run_editor = !AppConfig.exist?

    setup_app_config(od, logger)
    run_editor = true unless AppConfig.valid?

    logger.info(AppConfig.to_s) if  od["--show_config"]

    if run_editor || od["--edit_config"]
      editor = ConfigEditor.new
      @saved_interrupt_message = DvdProfiler2Xbmc.interrupt_message
      DvdProfiler2Xbmc.interrupt_message = ''
      editor.execute
      DvdProfiler2Xbmc.interrupt_message = @saved_interrupt_message
    end

    skip_execution = false
    %w(--help --version --show_config --edit_config).each {|flag| skip_execution = true if od[flag] }
    unless skip_execution || run_editor
      # create and execute class instance here
      app = DvdProfiler2Xbmc.instance
      app.execute
      app.report.each {|line| AppConfig[:logger].info line}
    end
  rescue Exception => eMsg
    logger.error {eMsg.to_s}
    logger.error {options.to_s}
    logger.error {eMsg.backtrace.join("\n")}
    exit_code = ExitCode::CRITICAL
  end
  exit_code
end

.reinitialize_logger(logger, quiet, debug) ⇒ Object

Synopsis

Reinitialize the logger using the loaded config.

logger

logger for any user messages

config

is the application's config hash.



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
# File 'lib/dvdprofiler2xbmc/views/cli.rb', line 178

def self.reinitialize_logger(logger, quiet, debug)
  # switch the logger to the one specified in the config files
  unless AppConfig[:logfile].blank?
    logfile_outputter = Log4r::RollingFileOutputter.new(:logfile, :filename => AppConfig[:logfile], :maxsize => 1000000 )
    logger.add logfile_outputter
    AppConfig[:logfile_level] ||= 'INFO'
    Log4r::Outputter[:logfile].formatter = Log4r::PatternFormatter.new(:pattern => "[%l] %d :: %M")
    level_map = {'DEBUG' => Log4r::DEBUG, 'INFO' => Log4r::INFO, 'WARN' => Log4r::WARN}
    logfile_outputter.level = level_map[AppConfig[:logfile_level].upcase] || Log4r::INFO
  end
  Log4r::Outputter[:console].level = Log4r::INFO
  Log4r::Outputter[:console].level = Log4r::WARN if quiet
  Log4r::Outputter[:console].level = Log4r::DEBUG if debug
  Log4r::Outputter[:console].formatter = Log4r::PatternFormatter.new(:pattern => "%m")
                                                                                   # logger.trace = true
  AppConfig[:logger] = logger
end

.setup_app_config(od, logger) ⇒ Object

Synopsis

the first reinitialize_logger adds the command line logging options to the default config then we load the config files then we run reinitialize_logger again to modify the logger for any logging options from the config files



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# File 'lib/dvdprofiler2xbmc/views/cli.rb', line 81

def self.setup_app_config(od, logger)
  # load config values
  AppConfig.default

  reinitialize_logger(logger, od["--quiet"], od["--debug"])
  AppConfig.load
  AppConfig.save
  AppConfig[:logfile] = od['--output'] if od['--output']
  AppConfig[:logfile_level] = od['--output_level'] if od['--output_level']
  reinitialize_logger(logger, od["--quiet"], od["--debug"])

  AppConfig[:do_update] = !od["--reports"]
  AppConfig[:force_nfo_replacement] = od["--force_nfo_replacement"]

  AppConfig[:logger].info { "logfile => #{AppConfig[:logfile].inspect}" } unless AppConfig[:logfile].nil?
  AppConfig[:logger].info { "logfile_level => #{AppConfig[:logfile_level].inspect}" } unless AppConfig[:logfile_level].nil?
end

.setup_loggerObject

Synopsis

Initial setup of logger



166
167
168
169
170
171
172
# File 'lib/dvdprofiler2xbmc/views/cli.rb', line 166

def self.setup_logger
  logger = Log4r::Logger.new('dvdprofiler2xbmc')
  logger.outputters = Log4r::StdoutOutputter.new(:console)
  Log4r::Outputter[:console].formatter  = Log4r::PatternFormatter.new(:pattern => "%m")
  logger.level = Log4r::DEBUG
  logger
end

.setup_parserObject

Synopsis

Setup the command line option parser

Returns

OptionParser instances



102
103
104
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'lib/dvdprofiler2xbmc/views/cli.rb', line 102

def self.setup_parser()
  options = CommandLine::OptionParser.new()

  # flag options
  [
    {
      :names           => %w(--version -v),
      :opt_found       => lambda {Log4r::Logger['dvdprofiler2xbmc'].info{"Dvdprofiler2xbmc #{Dvdprofiler2xbmc::VERSION}"}},
      :opt_description => "This version of dvdprofiler2xbmc"
    },
    {
      :names           => %w(--help -h),
      :opt_found       => lambda {Log4r::Logger['dvdprofiler2xbmc'].info{options.to_s}},
      :opt_description => "This usage information"
    },
    {
      :names           => %w(--show_config -s),
      :opt_description => "This is the current configuration information"
    },
    {
      :names           => %w(--edit_config -e),
      :opt_description => "Edit the current configuration information"
    },
    {
      :names           => %w(--quiet -q),
      :opt_description => 'Display error messages only'
    },
    {
      :names           => %w(--debug -d),
      :opt_description => 'Display debug messages'
    },
    {
      :names           => %w(--force_nfo_replacement -f),
      :opt_description => 'Delete old .nfo files and generate new ones'
    },
    {
      :names           => %w(--reports -r),
      :opt_description => 'Display reports only.  Do not do any updates.'
    }
  ].each { |opt| options << CommandLine::Option.new(:flag, opt) }

  # non-flag options
  [
    {
      :names           => %w(--output -o),
      :arity           => [1,1],
      :arg_description => 'logfile',
      :opt_description => 'Write log messages to file. Default = no log file',
      :opt_found       => CommandLine::OptionParser::GET_ARGS
    },
    {
      :names           => %w(--output_level -l),
      :arity           => [1,1],
      :arg_description => 'level',
      :opt_description => 'Output logging level: DEBUG, INFO, WARN, ERROR. Default = INFO',
      :opt_found       => CommandLine::OptionParser::GET_ARGS
    }
  ].each { |opt| options << CommandLine::Option.new(opt) }

  options
end