Class: Arachni::UI::CLI::OptionParser

Inherits:
Object
  • Object
show all
Includes:
Utilities, Output
Defined in:
ui/cli/option_parser.rb

Overview

Author:

Instance Method Summary collapse

Methods included from Utilities

#list_checks, #list_platforms, #list_plugins, #list_reporters, #load_profile, #print_banner, #print_issues, #save_profile

Methods included from Support::Mixins::Terminal

#clear_screen, #empty_screen, #flush, #move_to_home, #reprint, #reputs, #restr

Methods included from Arachni::Utilities

#available_port, available_port_mutex, #bytes_to_kilobytes, #bytes_to_megabytes, #caller_name, #caller_path, #cookie_decode, #cookie_encode, #cookies_from_file, #cookies_from_parser, #cookies_from_response, #exception_jail, #exclude_path?, #follow_protocol?, #form_decode, #form_encode, #forms_from_parser, #forms_from_response, #full_and_absolute_url?, #generate_token, #get_path, #hms_to_seconds, #html_decode, #html_encode, #include_path?, #links_from_parser, #links_from_response, #normalize_url, #page_from_response, #page_from_url, #parse_set_cookie, #path_in_domain?, #path_too_deep?, #port_available?, #rand_port, #random_seed, #redundant_path?, #regexp_array_match, #remove_constants, #request_parse_body, #seconds_to_hms, #skip_page?, #skip_path?, #skip_resource?, #skip_response?, #to_absolute, #uri_decode, #uri_encode, #uri_parse, #uri_parse_query, #uri_parser, #uri_rewrite

Methods included from Output

#caller_location, #debug?, #debug_level, #debug_level_1?, #debug_level_2?, #debug_level_3?, #debug_level_4?, #debug_off, #debug_on, #disable_only_positives, #error_buffer, #error_log_fd, #error_logfile, #has_error_log?, #included, #log_error, #mute, #muted?, #only_positives, #only_positives?, #print_bad, #print_debug, #print_debug_backtrace, #print_debug_exception, #print_debug_level_1, #print_debug_level_2, #print_debug_level_3, #print_debug_level_4, #print_error, #print_error_backtrace, #print_exception, #print_info, #print_line, #print_ok, #print_status, #print_verbose, #reroute_to_file, #reroute_to_file?, reset_output_options, #set_error_logfile, #unmute, #verbose?, #verbose_off, #verbose_on

Constructor Details

#initialize ⇒ OptionParser

Returns a new instance of OptionParser.



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'ui/cli/option_parser.rb', line 20

def initialize
    separator ''
    separator 'Generic'

    # This is CLI-related only and not a system option so we set the default here.
    options.datastore.report_path = options.paths.config['cli']['report_path']

    on( '-h', '--help', 'Output this message.' ) do
        puts parser
        exit
    end

    on( '--version', 'Show version information.' ) do
        puts "Arachni #{Arachni::VERSION} (#{RUBY_ENGINE} #{RUBY_VERSION}" <<
                 "p#{RUBY_PATCHLEVEL}) [#{RUBY_PLATFORM}]"
        exit
    end
end

Instance Method Details

#after_parse ⇒ Object

This method is abstract. 


80
81
 
# File 'ui/cli/option_parser.rb', line 80

def after_parse
end
 


54
55
56
 
# File 'ui/cli/option_parser.rb', line 54

def banner
    "Usage: #{$0} [options]"
end

#on(*args, &block) ⇒ Object 



43
44
45
46
47
48
49
50
51
52
 
# File 'ui/cli/option_parser.rb', line 43

def on( *args, &block )
    parser.on( *args ) do |*bargs|
        begin
            block.call *bargs
        rescue => e
            print_bad "#{args.first.split( /\s/ ).first}: [#{e.class}] #{e}"
            exit 1
        end
    end
end

#options ⇒ Object 



87
88
89
 
# File 'ui/cli/option_parser.rb', line 87

def options
    Arachni::Options.instance
end

#parse ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'ui/cli/option_parser.rb', line 62

def parse
    print_banner

    # Make the formatting a bit clearer with indentation for subsequent
    # description lines and empty lines between options.
    parser.top.each_option do |option|
        next if option.is_a? String
        option.desc.replace ([option.desc.shift] + option.desc.map { |l| "  #{l}" })
        option.desc << ' '
    end

    parser.parse!

    after_parse
    validate
end

#parser ⇒ Object 



58
59
60
 
# File 'ui/cli/option_parser.rb', line 58

def parser
    @parser ||= ::OptionParser.new( banner, 27, '  ' )
end

#separator(*args) ⇒ Object 



39
40
41
 
# File 'ui/cli/option_parser.rb', line 39

def separator( *args )
    parser.separator( *args )
end

#validate ⇒ Object

This method is abstract. 


84
85
 
# File 'ui/cli/option_parser.rb', line 84

def validate
end