module Brakeman

# File lib/brakeman.rb, line 573
def self.add_external_checks options
  options[:additional_checks_path].each do |path|
    Brakeman::Checks.initialize_checks path
  end if options[:additional_checks_path]
end

# File lib/brakeman.rb, line 579
def self.check_for_missing_checks included_checks, excluded_checks, enabled_checks
  checks = included_checks.to_a + excluded_checks.to_a + enabled_checks.to_a

  missing = Brakeman::Checks.missing_checks(checks)

  unless missing.empty?
    raise MissingChecksError, "Could not find specified check#{missing.length > 1 ? 's' : ''}: #{missing.map {|c| "`#{c}`"}.join(', ')}"
  end
end

# File lib/brakeman.rb, line 484
def self.compare options
  require 'json'
  require 'brakeman/differ'
  raise ArgumentError.new("Comparison file doesn't exist") unless File.exist? options[:previous_results_json]

  begin
    previous_results = JSON.parse(File.read(options[:previous_results_json]), :symbolize_names => true)[:warnings]
  rescue JSON::ParserError
    self.notify "Error parsing comparison file: #{options[:previous_results_json]}"
    exit!
  end

  tracker = run(options)
  new_report = JSON.parse(tracker.report.to_json, symbolize_names: true)

  new_results = new_report[:warnings]
  obsolete_ignored = tracker.unused_fingerprints

  Brakeman::Differ.new(new_results, previous_results).diff.tap do |diff|
    diff[:obsolete] = obsolete_ignored
  end
end

# File lib/brakeman.rb, line 173
def self.config_file custom_location, app_path
  app_config = File.expand_path(File.join(app_path, "config", "brakeman.yml"))
  supported_locations = [File.expand_path(custom_location || ""), app_config] + CONFIG_FILES
  supported_locations.detect {|f| File.file?(f) }
end

# File lib/brakeman.rb, line 479
def self.debug message
  $stderr.puts message if @debug
end

# File lib/brakeman.rb, line 589
def self.debug= val
  @debug = val
end

# File lib/brakeman.rb, line 180
def self.default_options
  { :assume_all_routes => true,
    :check_arguments => true,
    :collapse_mass_assignment => false,
    :combine_locations => true,
    :engine_paths => ["engines/*"],
    :exit_on_error => true,
    :exit_on_warn => true,
    :highlight_user_input => true,
    :html_style => "#{File.expand_path(File.dirname(__FILE__))}/brakeman/format/style.css",
    :ignore_model_output => false,
    :ignore_redirect_to_model => true,
    :index_libs => true,
    :message_limit => 100,
    :min_confidence => 2,
    :output_color => true,
    :pager => true,
    :parallel_checks => true,
    :parser_timeout => 10,
    :relative_path => false,
    :report_progress => true,
    :safe_methods => Set.new,
    :show_ignored => false,
    :sql_safe_methods => Set.new,
    :skip_checks => Set.new,
    :skip_vendor => true,
  }
end

# File lib/brakeman.rb, line 339
def self.dump_config options
  require 'yaml'
  if options[:create_config].is_a? String
    file = options[:create_config]
  else
    file = nil
  end

  options.delete :create_config

  options.each do |k,v|
    if v.is_a? Set
      options[k] = v.to_a
    end
  end

  if file
    File.open file, "w" do |f|
      YAML.dump options, f
    end
    notify "Output configuration to #{file}"
  else
    notify YAML.dump(options)
  end
end

# File lib/brakeman.rb, line 365
def self.ensure_latest
  current = Brakeman::Version
  latest = Gem.latest_version_for('brakeman').to_s
  if current != latest
    "Brakeman #{current} is not the latest version #{latest}"
  end
end

# File lib/brakeman.rb, line 545
def self.filter_warnings tracker, options
  require 'brakeman/report/ignore/config'

  app_tree = Brakeman::AppTree.from_options(options)

  if options[:ignore_file]
    file = options[:ignore_file]
  elsif app_tree.exists? "config/brakeman.ignore"
    file = app_tree.expand_path("config/brakeman.ignore")
  elsif not options[:interactive_ignore]
    return
  end

  notify "Filtering warnings..."

  if options[:interactive_ignore]
    require 'brakeman/report/ignore/interactive'
    config = InteractiveIgnorer.new(file, tracker.warnings).start
  else
    notify "[Notice] Using '#{file}' to filter warnings"
    config = IgnoreConfig.new(file, tracker.warnings)
    config.read_from_file
    config.filter_ignored
  end

  tracker.ignored_filter = config
end

# File lib/brakeman.rb, line 211
def self.get_output_formats options
  #Set output format
  if options[:output_format] && options[:output_files] && options[:output_files].size > 1
    raise ArgumentError, "Cannot specify output format if multiple output files specified"
  end
  if options[:output_format]
    get_formats_from_output_format options[:output_format]
  elsif options[:output_files]
    get_formats_from_output_files options[:output_files]
  else
    begin
      self.load_brakeman_dependency 'terminal-table', :allow_fail
      return [:to_s]
    rescue LoadError
      return [:to_json]
    end
  end
end

# File lib/brakeman.rb, line 535
def self.ignore_file_entries_with_empty_notes file
  return [] unless file

  require 'brakeman/report/ignore/config'

  config = IgnoreConfig.new(file, nil)
  config.read_from_file
  config.already_ignored_entries_with_empty_notes.map { |i| i[:fingerprint] }
end

# File lib/brakeman.rb, line 317
def self.list_checks options
  require 'brakeman/scanner'

  add_external_checks options

  if options[:list_optional_checks]
    $stderr.puts "Optional Checks:"
    checks = Checks.optional_checks
  else
    $stderr.puts "Available Checks:"
    checks = Checks.checks
  end

  format_length = 30

  $stderr.puts "-" * format_length
  checks.each do |check|
    $stderr.printf("%-#{format_length}s%s\n", check.name, check.description)
  end
end

# File lib/brakeman.rb, line 507
def self.load_brakeman_dependency name, allow_fail = false
  return if @loaded_dependencies.include? name

  unless @vendored_paths
    path_load = "#{File.expand_path(File.dirname(__FILE__))}/../bundle/load.rb"

    if File.exist? path_load
      require path_load
    end

    @vendored_paths = true
  end

  begin
    require name
  rescue LoadError => e
    if allow_fail
      raise e
    else
      $stderr.puts e.message
      $stderr.puts "Please install the appropriate dependency: #{name}."
      exit!(-1)
    end
  end
end

# File lib/brakeman.rb, line 125
def self.load_options line_options
  custom_location = line_options[:config_file]
  quiet = line_options[:quiet]
  app_path = line_options[:app_path]

  #Load configuration file
  if config = config_file(custom_location, app_path)
    require 'yaml'
    options = YAML.safe_load_file config, permitted_classes: [Symbol], symbolize_names: true

    if options
      options.each { |k, v| options[k] = Set.new v if v.is_a? Array }

      # After parsing the yaml config file for options, convert any string keys into symbols.
      options.keys.select {|k| k.is_a? String}.map {|k| k.to_sym }.each {|k| options[k] = options[k.to_s]; options.delete(k.to_s) }

      unless line_options[:allow_check_paths_in_config]
        if options.include? :additional_checks_path
          options.delete :additional_checks_path

          notify "[Notice] Ignoring additional check paths in config file. Use --allow-check-paths-in-config to allow" unless (options[:quiet] || quiet)
        end
      end

      # notify if options[:quiet] and quiet is nil||false
      notify "[Notice] Using configuration in #{config}" unless (options[:quiet] || quiet)
      options
    else
      notify "[Notice] Empty configuration file: #{config}" unless quiet
      {}
    end
  else
    {}
  end
end

# File lib/brakeman.rb, line 475
def self.notify message
  $stderr.puts message unless @quiet
end

# File lib/brakeman.rb, line 593
def self.quiet= val
  @quiet = val
end

# File lib/brakeman.rb, line 464
def self.rescan tracker, files, options = {}
  require 'brakeman/rescanner'

  tracker.options.merge! options

  @quiet = !!tracker.options[:quiet]
  @debug = !!tracker.options[:debug]

  Rescanner.new(tracker.options, tracker.processor, files).recheck
end

# File lib/brakeman.rb, line 77
def self.run options
  options = set_options options

  @quiet = !!options[:quiet]
  @debug = !!options[:debug]

  if @quiet
    options[:report_progress] = false
  end

  scan options
end

# File lib/brakeman.rb, line 374
def self.scan options
  #Load scanner
  notify "Loading scanner..."

  begin
    require 'brakeman/scanner'
  rescue LoadError
    raise NoBrakemanError, "Cannot find lib/ directory."
  end

  add_external_checks options

  #Start scanning
  scanner = Scanner.new options
  tracker = scanner.tracker

  check_for_missing_checks options[:run_checks], options[:skip_checks], options[:enable_checks]

  notify "Processing application in #{tracker.app_path}"
  scanner.process

  if options[:parallel_checks]
    notify "Running checks in parallel..."
  else
    notify "Running checks..."
  end

  tracker.run_checks

  self.filter_warnings tracker, options

  if options[:output_files]
    notify "Generating report..."

    write_report_to_files tracker, options[:output_files]
  elsif options[:print_report]
    notify "Generating report..."

    write_report_to_formats tracker, options[:output_formats]
  end

  tracker
end

# File lib/brakeman.rb, line 91
def self.set_options options
  if options.is_a? String
    options = { :app_path => options }
  end

  if options[:quiet] == :command_line
    command_line = true
    options.delete :quiet
  end

  options = default_options.merge(load_options(options)).merge(options)

  if options[:quiet].nil? and not command_line
    options[:quiet] = true
  end

  if options[:rails4]
    options[:rails3] = true
  elsif options[:rails5]
    options[:rails3] = true
    options[:rails4] = true
  elsif options[:rails6]
    options[:rails3] = true
    options[:rails4] = true
    options[:rails5] = true
  end

  options[:output_formats] = get_output_formats options
  options[:github_url] = get_github_url options

  options
end

# File lib/brakeman.rb, line 264
def self.get_formats_from_output_files output_files
  output_files.map do |output_file|
    case output_file
    when /\.html$/i
      :to_html
    when /\.csv$/i
      :to_csv
    when /\.pdf$/i
      :to_pdf
    when /\.tabs$/i
      :to_tabs
    when /\.json$/i
      :to_json
    when /\.md$/i
      :to_markdown
    when /(\.cc|\.codeclimate)$/i
      :to_codeclimate
    when /\.plain$/i
      :to_text
    when /\.table$/i
      :to_table
    when /\.junit$/i
      :to_junit
    when /\.sarif$/i
      :to_sarif
    when /\.sonar$/i
      :to_sonar
    when /\.github$/i
      :to_github
    else
      :to_text
    end
  end
end

# File lib/brakeman.rb, line 230
def self.get_formats_from_output_format output_format
  case output_format
  when :html, :to_html
    [:to_html]
  when :csv, :to_csv
    [:to_csv]
  when :pdf, :to_pdf
    [:to_pdf]
  when :tabs, :to_tabs
    [:to_tabs]
  when :json, :to_json
    [:to_json]
  when :markdown, :to_markdown
    [:to_markdown]
  when :cc, :to_cc, :codeclimate, :to_codeclimate
    [:to_codeclimate]
  when :plain ,:to_plain, :text, :to_text, :to_s
    [:to_text]
  when :table, :to_table
    [:to_table]
  when :junit, :to_junit
    [:to_junit]
  when :sarif, :to_sarif
    [:to_sarif]
  when :sonar, :to_sonar
    [:to_sonar]
  when :github, :to_github
    [:to_github]
  else
    [:to_text]
  end
end

# File lib/brakeman.rb, line 300
def self.get_github_url options
  if github_repo = options[:github_repo]
    full_repo, ref = github_repo.split '@', 2
    name, repo, path = full_repo.split '/', 3
    unless name && repo && !(name.empty? || repo.empty?)
      raise ArgumentError, "Invalid GitHub repository format"
    end
    path.chomp '/' if path
    ref ||= 'master'
    ['https://github.com', name, repo, 'blob', ref, path].compact.join '/'
  else
    nil
  end
end

# File lib/brakeman.rb, line 418
def self.write_report_to_files tracker, output_files
  require 'fileutils'
  tracker.options[:output_color] = false unless tracker.options[:output_color] == :force

  output_files.each_with_index do |output_file, idx|
    dir = File.dirname(output_file)
    unless Dir.exist? dir
      FileUtils.mkdir_p(dir)
    end

    File.open output_file, "w" do |f|
      f.write tracker.report.format(tracker.options[:output_formats][idx])
    end
    notify "Report saved in '#{output_file}'"
  end
end

# File lib/brakeman.rb, line 436
def self.write_report_to_formats tracker, output_formats
  unless $stdout.tty? or tracker.options[:output_color] == :force
    tracker.options[:output_color] = false
  end

  if not $stdout.tty? or not tracker.options[:pager] or output_formats.length > 1 # does this ever happen??
    output_formats.each do |output_format|
      puts tracker.report.format(output_format)
    end
  else
    require "brakeman/report/pager"

    Brakeman::Pager.new(tracker).page_report(tracker.report, output_formats.first)
  end
end