brew/Library/Homebrew/linkage_checker.rb

require "keg"
require "formula"
require "linkage_cache_store"

class LinkageChecker
  def initialize(keg, formula = nil, use_cache: false, cache_db:)
    @keg = keg
    @formula = formula || resolve_formula(keg)

    if use_cache
      @store = LinkageCacheStore.new(keg.name, cache_db)
      flush_cache_and_check_dylibs unless @store.keg_exists?
    else
      flush_cache_and_check_dylibs
    end
  end

  def display_normal_output
    display_items "System libraries", system_dylibs
    display_items "Homebrew libraries", brewed_dylibs
    display_items "Indirect dependencies with linkage", indirect_deps
    display_items "Variable-referenced libraries", variable_dylibs
    display_items "Missing libraries", broken_dylibs
    display_items "Broken dependencies", broken_deps
    display_items "Undeclared dependencies with linkage", undeclared_deps
    display_items "Dependencies with no linkage", unnecessary_deps
  end

  def display_reverse_output
    return if reverse_links.empty?
    sorted = reverse_links.sort
    sorted.each do |dylib, files|
      puts dylib
      files.each do |f|
        unprefixed = f.to_s.strip_prefix "#{keg}/"
        puts "  #{unprefixed}"
      end
      puts unless dylib == sorted.last[0]
    end
  end

  def display_test_output(puts_output: true)
    display_items "Missing libraries", broken_dylibs, puts_output: puts_output
    display_items "Broken dependencies", broken_deps, puts_output: puts_output
    puts "No broken library linkage" unless broken_library_linkage?
  end

  def broken_library_linkage?
    !broken_dylibs.empty? || !broken_deps.empty?
  end

  def undeclared_deps
    @undeclared_deps ||= store.fetch_type(:undeclared_deps)
  end

  private

  attr_reader :keg, :formula, :store

  # 'Hash-type' cache values

  def brewed_dylibs
    @brewed_dylibs ||= store.fetch_type(:brewed_dylibs)
  end

  def reverse_links
    @reverse_links ||= store.fetch_type(:reverse_links)
  end

  def broken_deps
    @broken_deps ||= store.fetch_type(:broken_deps)
  end

  # 'Path-type' cached values

  def system_dylibs
    @system_dylibs ||= store.fetch_type(:system_dylibs)
  end

  def broken_dylibs
    @broken_dylibs ||= store.fetch_type(:broken_dylibs)
  end

  def variable_dylibs
    @variable_dylibs ||= store.fetch_type(:variable_dylibs)
  end

  def indirect_deps
    @indirect_deps ||= store.fetch_type(:indirect_deps)
  end

  def unnecessary_deps
    @unnecessary_deps ||= store.fetch_type(:unnecessary_deps)
  end

  def dylib_to_dep(dylib)
    dylib =~ %r{#{Regexp.escape(HOMEBREW_PREFIX)}/(opt|Cellar)/([\w+-.@]+)/}
    Regexp.last_match(2)
  end

  def flush_cache_and_check_dylibs
    reset_dylibs!

    checked_dylibs = Set.new
    @keg.find do |file|
      next if file.symlink? || file.directory?
      next if !file.dylib? && !file.binary_executable? && !file.mach_o_bundle?

      # weakly loaded dylibs may not actually exist on disk, so skip them
      # when checking for broken linkage
      file.dynamically_linked_libraries(except: :LC_LOAD_WEAK_DYLIB)
          .each do |dylib|
        @reverse_links[dylib] << file
        next if checked_dylibs.include? dylib
        if dylib.start_with? "@"
          @variable_dylibs << dylib
        else
          begin
            owner = Keg.for Pathname.new(dylib)
          rescue NotAKegError
            @system_dylibs << dylib
          rescue Errno::ENOENT
            next if harmless_broken_link?(dylib)
            if (dep = dylib_to_dep(dylib))
              @broken_deps[dep] |= [dylib]
            else
              @broken_dylibs << dylib
            end
          else
            tap = Tab.for_keg(owner).tap
            f = if tap.nil? || tap.core_tap?
              owner.name
            else
              "#{tap}/#{owner.name}"
            end
            @brewed_dylibs[f] << dylib
          end
        end
        checked_dylibs << dylib
      end
    end

    if formula
      @indirect_deps, @undeclared_deps, @unnecessary_deps =
        check_undeclared_deps
    end
    store_dylibs!
  end

  def check_undeclared_deps
    filter_out = proc do |dep|
      next true if dep.build?
      next false unless dep.optional? || dep.recommended?
      formula.build.without?(dep)
    end

    declared_deps_full_names = formula.deps
                                      .reject { |dep| filter_out.call(dep) }
                                      .map(&:name)
    declared_deps_names = declared_deps_full_names.map do |dep|
      dep.split("/").last
    end
    recursive_deps = formula.declared_runtime_dependencies.map do |dep|
      begin
        dep.to_formula.name
      rescue FormulaUnavailableError
        nil
      end
    end.compact

    indirect_deps = []
    undeclared_deps = []
    @brewed_dylibs.each_key do |full_name|
      name = full_name.split("/").last
      next if name == formula.name
      if recursive_deps.include?(name)
        indirect_deps << full_name unless declared_deps_names.include?(name)
      else
        undeclared_deps << full_name
      end
    end

    sort_by_formula_full_name!(indirect_deps)
    sort_by_formula_full_name!(undeclared_deps)

    unnecessary_deps = declared_deps_full_names.reject do |full_name|
      next true if Formula[full_name].bin.directory?
      name = full_name.split("/").last
      @brewed_dylibs.keys.map { |x| x.split("/").last }.include?(name)
    end

    missing_deps = @broken_deps.values.flatten.map { |d| dylib_to_dep(d) }
    unnecessary_deps -= missing_deps

    [indirect_deps, undeclared_deps, unnecessary_deps]
  end

  def sort_by_formula_full_name!(arr)
    arr.sort! do |a, b|
      if a.include?("/") && !b.include?("/")
        1
      elsif !a.include?("/") && b.include?("/")
        -1
      else
        a <=> b
      end
    end
  end

  # Whether or not dylib is a harmless broken link, meaning that it's
  # okay to skip (and not report) as broken.
  def harmless_broken_link?(dylib)
    # libgcc_s_* is referenced by programs that use the Java Service Wrapper,
    # and is harmless on x86(_64) machines
    [
      "/usr/lib/libgcc_s_ppc64.1.dylib",
      "/opt/local/lib/libgcc/libgcc_s.1.dylib",
    ].include?(dylib)
  end

  # Display a list of things.
  # Things may either be an array, or a hash of (label -> array)
  def display_items(label, things, puts_output: true)
    return if things.empty?
    output = "#{label}:"
    if things.is_a? Hash
      things.keys.sort.each do |list_label|
        things[list_label].sort.each do |item|
          output += "\n  #{item} (#{list_label})"
        end
      end
    else
      things.sort.each do |item|
        output += "\n  #{item}"
      end
    end
    puts output if puts_output
    output
  end

  def resolve_formula(keg)
    Formulary.from_keg(keg)
  rescue FormulaUnavailableError
    opoo "Formula unavailable: #{keg.name}"
  end

  # Helper function to reset dylib values
  def reset_dylibs!
    store&.flush_cache!
    @system_dylibs    = Set.new
    @broken_dylibs    = Set.new
    @variable_dylibs  = Set.new
    @brewed_dylibs    = Hash.new { |h, k| h[k] = Set.new }
    @reverse_links    = Hash.new { |h, k| h[k] = Set.new }
    @broken_deps      = Hash.new { |h, k| h[k] = [] }
    @indirect_deps    = []
    @undeclared_deps  = []
    @unnecessary_deps = []
  end

  # Updates data store with package path values
  def store_dylibs!
    store&.update!(
      system_dylibs: system_dylibs,
      variable_dylibs: variable_dylibs,
      broken_dylibs: broken_dylibs,
      indirect_deps: indirect_deps,
      broken_deps: broken_deps,
      undeclared_deps: undeclared_deps,
      unnecessary_deps: unnecessary_deps,
      brewed_dylibs: brewed_dylibs,
      reverse_links: reverse_links,
    )
  end
end