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

Inherits:
OptionParser show all
Defined in:
ui/cli/reporter/option_parser.rb

Overview

Author:

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from OptionParser

#on, #options, #parse, #parser, #separator

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

#initializeOptionParser

Returns a new instance of OptionParser.


31
32
33
34
35
36
# File 'ui/cli/reporter/option_parser.rb', line 31

def initialize(*)
    super

    @framework = Arachni::Framework.new
    @reporters = {}
end

Instance Attribute Details

#frameworkObject (readonly)

Returns the value of attribute framework


19
20
21
# File 'ui/cli/reporter/option_parser.rb', line 19

def framework
  @framework
end

#report_pathObject

Returns the value of attribute report_path


29
30
31
# File 'ui/cli/reporter/option_parser.rb', line 29

def report_path
  @report_path
end

#reportersHash{<String, Symbol> => Hash{String => String}}

Returns Reports to load, by name, as keys and their options as values.

Returns:

See Also:


27
28
29
# File 'ui/cli/reporter/option_parser.rb', line 27

def reporters
  @reporters
end

Instance Method Details

#after_parseObject


61
62
63
# File 'ui/cli/reporter/option_parser.rb', line 61

def after_parse
    @report_path = ARGV.shift
end

95
96
97
# File 'ui/cli/reporter/option_parser.rb', line 95

def banner
    "Usage: #{$0} REPORT"
end

#reporterObject


38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# File 'ui/cli/reporter/option_parser.rb', line 38

def reporter
    separator ''
    separator 'Reporters'

    on( '--reporters-list [GLOB]',
        'List available reporters based on the provided glob.',
        '(If no glob is provided all will be listed.)'
    ) do |pattern|
        list_reporters( framework.list_reporters( pattern ) )
        exit
    end

    on( "--reporter 'REPORTER:OPTION=VALUE,OPTION2=VALUE2'",
        "REPORTER is the name of the reporter as displayed by '--reporters-list'.",
        "(Reporters are referenced by their filename without the '.rb' " +
            "extension, use '--reporters-list' to list all.)",
        '(Default: stdout)',
        '(Can be used multiple times.)'
    ) do |reporter|
        prepare_component_options( reporters, reporter )
    end
end

#validateObject


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
# File 'ui/cli/reporter/option_parser.rb', line 65

def validate
    if !@report_path
        print_error 'No report file provided.'
        exit 1
    end

    @report_path = File.expand_path( @report_path )

    if !File.exists?( @report_path )
        print_error "Report does not exist: #{@report_path}"
        exit 1
    end

    if reporters.any?
        begin
            framework.reporters.load( reporters.keys )
        rescue Component::Error::NotFound => e
            print_error e
            print_info 'Available reporters are:'
            print_info framework.reporters.available.join( ', ' )
            print_line
            print_info 'Use the \'--reporters-list\' parameter to see a' <<
                           ' detailed list of all available reports.'
            exit 1
        ensure
            framework.reporters.clear
        end
    end
end