brew/Library/Homebrew/tab.rb

# typed: true # rubocop:todo Sorbet/StrictSigil
# frozen_string_literal: true

require "cxxstdlib"
require "options"
require "json"
require "development_tools"
require "cachable"

# Rather than calling `new` directly, use one of the class methods like {Tab.create}.
class AbstractTab
  extend Cachable
  extend T::Helpers

  abstract!

  FILENAME = "INSTALL_RECEIPT.json"

  # Check whether the formula or cask was installed as a dependency.
  #
  # @api internal
  sig { returns(T.nilable(T::Boolean)) } # TODO: change this to always return a boolean
  attr_accessor :installed_as_dependency

  # Check whether the formula or cask was installed on request.
  #
  # @api internal
  sig { returns(T.nilable(T::Boolean)) } # TODO: change this to always return a boolean
  attr_accessor :installed_on_request

  sig { returns(T.nilable(String)) }
  attr_accessor :homebrew_version

  attr_accessor :tabfile, :loaded_from_api, :time, :arch, :source, :built_on

  # Returns the formula or cask runtime dependencies.
  #
  # @api internal
  attr_accessor :runtime_dependencies

  sig { params(attributes: T::Hash[String, T.untyped]).void }
  def initialize(attributes = {})
    @installed_as_dependency = T.let(nil, T.nilable(T::Boolean))
    @installed_on_request = T.let(nil, T.nilable(T::Boolean))
    @homebrew_version = T.let(nil, T.nilable(String))
    @tabfile = T.let(nil, T.nilable(Pathname))
    @loaded_from_api = T.let(nil, T.nilable(T::Boolean))
    @time = T.let(nil, T.nilable(Integer))
    @arch = T.let(nil, T.nilable(String))
    @source = T.let(nil, T.nilable(T::Hash[String, T.untyped]))
    @built_on = T.let(nil, T.nilable(T::Hash[String, T.untyped]))
    @runtime_dependencies = T.let(nil, T.nilable(T::Array[T.untyped]))

    attributes.each { |key, value| instance_variable_set(:"@#{key}", value) }
  end

  # Instantiates a {Tab} for a new installation of a formula or cask.
  sig { params(formula_or_cask: T.any(Formula, Cask::Cask)).returns(T.attached_class) }
  def self.create(formula_or_cask)
    attributes = {
      "homebrew_version"        => HOMEBREW_VERSION,
      "installed_as_dependency" => false,
      "installed_on_request"    => false,
      "loaded_from_api"         => formula_or_cask.loaded_from_api?,
      "time"                    => Time.now.to_i,
      "arch"                    => Hardware::CPU.arch,
      "source"                  => {
        "tap"          => formula_or_cask.tap&.name,
        "tap_git_head" => formula_or_cask.tap_git_head,
      },
      "built_on"                => DevelopmentTools.build_system_info,
    }

    new(attributes)
  end

  # Returns the {Tab} for a formula or cask install receipt at `path`.
  #
  # NOTE: Results are cached.
  sig { params(path: T.any(Pathname, String)).returns(T.attached_class) }
  def self.from_file(path)
    cache.fetch(path) do |p|
      content = File.read(p)
      return empty if content.blank?

      cache[p] = from_file_content(content, p)
    end
  end

  # Like {from_file}, but bypass the cache.
  sig { params(content: String, path: T.any(Pathname, String)).returns(T.attached_class) }
  def self.from_file_content(content, path)
    attributes = begin
      JSON.parse(content)
    rescue JSON::ParserError => e
      raise e, "Cannot parse #{path}: #{e}", e.backtrace
    end
    attributes["tabfile"] = path

    new(attributes)
  end

  sig { returns(T.attached_class) }
  def self.empty
    attributes = {
      "homebrew_version"        => HOMEBREW_VERSION,
      "installed_as_dependency" => false,
      "installed_on_request"    => false,
      "loaded_from_api"         => false,
      "time"                    => nil,
      "runtime_dependencies"    => nil,
      "arch"                    => nil,
      "source"                  => {
        "path"         => nil,
        "tap"          => nil,
        "tap_git_head" => nil,
      },
      "built_on"                => DevelopmentTools.build_system_info,
    }

    new(attributes)
  end

  def self.formula_to_dep_hash(formula, declared_deps)
    {
      "full_name"         => formula.full_name,
      "version"           => formula.version.to_s,
      "revision"          => formula.revision,
      "bottle_rebuild"    => formula.bottle&.rebuild,
      "pkg_version"       => formula.pkg_version.to_s,
      "declared_directly" => declared_deps.include?(formula.full_name),
    }.compact
  end
  private_class_method :formula_to_dep_hash

  sig { returns(Version) }
  def parsed_homebrew_version
    homebrew_version = self.homebrew_version
    return Version::NULL if homebrew_version.nil?

    Version.new(homebrew_version)
  end

  sig { returns(T.nilable(Tap)) }
  def tap
    tap_name = source["tap"]
    Tap.fetch(tap_name) if tap_name
  end

  sig { params(tap: T.nilable(T.any(Tap, String))).void }
  def tap=(tap)
    tap_name = tap.is_a?(Tap) ? tap.name : tap
    source["tap"] = tap_name
  end

  sig { void }
  def write
    self.class.cache[tabfile] = self
    tabfile.atomic_write(to_json)
  end
end

class Tab < AbstractTab
  # Check whether the formula was poured from a bottle.
  #
  # @api internal
  attr_accessor :poured_from_bottle

  attr_accessor :built_as_bottle, :changed_files, :stdlib, :aliases
  attr_writer :used_options, :unused_options, :compiler, :source_modified_time
  attr_reader :tapped_from

  sig { params(attributes: T::Hash[String, T.untyped]).void }
  def initialize(attributes = {})
    @poured_from_bottle = T.let(nil, T.nilable(T::Boolean))
    @built_as_bottle = T.let(nil, T.nilable(T::Boolean))
    @changed_files = T.let(nil, T.nilable(T::Array[Pathname]))
    @stdlib = T.let(nil, T.nilable(String))
    @aliases = T.let(nil, T.nilable(T::Array[String]))
    @used_options = T.let(nil, T.nilable(T::Array[String]))
    @unused_options = T.let(nil, T.nilable(T::Array[String]))
    @compiler = T.let(nil, T.nilable(String))
    @source_modified_time = T.let(nil, T.nilable(Integer))
    @tapped_from = T.let(nil, T.nilable(String))

    super
  end

  # Instantiates a {Tab} for a new installation of a formula.
  sig {
    override.params(formula_or_cask: T.any(Formula, Cask::Cask), compiler: T.any(Symbol, String),
                    stdlib: T.nilable(T.any(String, Symbol))).returns(T.attached_class)
  }
  def self.create(formula_or_cask, compiler = DevelopmentTools.default_compiler, stdlib = nil)
    formula = T.cast(formula_or_cask, Formula)

    tab = super(formula)
    build = formula.build
    runtime_deps = formula.runtime_dependencies(undeclared: false)

    tab.used_options = build.used_options.as_flags
    tab.unused_options = build.unused_options.as_flags
    tab.tabfile = formula.prefix/FILENAME
    tab.built_as_bottle = build.bottle?
    tab.poured_from_bottle = false
    tab.source_modified_time = formula.source_modified_time.to_i
    tab.compiler = compiler
    tab.stdlib = stdlib
    tab.aliases = formula.aliases
    tab.runtime_dependencies = Tab.runtime_deps_hash(formula, runtime_deps)
    tab.source["spec"] = formula.active_spec_sym.to_s
    tab.source["path"] = formula.specified_path.to_s
    tab.source["versions"] = {
      "stable"         => formula.stable&.version&.to_s,
      "head"           => formula.head&.version&.to_s,
      "version_scheme" => formula.version_scheme,
    }

    tab
  end

  # Like {from_file}, but bypass the cache.
  sig { params(content: String, path: T.any(Pathname, String)).returns(T.attached_class) }
  def self.from_file_content(content, path)
    tab = super

    tab.source ||= {}

    tab.tap = tab.tapped_from if !tab.tapped_from.nil? && tab.tapped_from != "path or URL"
    tab.tap = "homebrew/core" if ["mxcl/master", "Homebrew/homebrew"].include?(tab.tap)

    if tab.source["spec"].nil?
      version = PkgVersion.parse(File.basename(File.dirname(path)))
      tab.source["spec"] = if version.head?
        "head"
      else
        "stable"
      end
    end

    tab.source["versions"] ||= empty_source_versions

    # Tabs created with Homebrew 1.5.13 through 4.0.17 inclusive created empty string versions in some cases.
    ["stable", "head"].each do |spec|
      tab.source["versions"][spec] = tab.source["versions"][spec].presence
    end

    tab
  end

  # Get the {Tab} for the given {Keg},
  # or a fake one if the formula is not installed.
  #
  # @api internal
  sig { params(keg: T.any(Keg, Pathname)).returns(T.attached_class) }
  def self.for_keg(keg)
    path = keg/FILENAME

    tab = if path.exist?
      from_file(path)
    else
      empty
    end

    tab.tabfile = path
    tab
  end

  # Returns a {Tab} for the named formula's installation,
  # or a fake one if the formula is not installed.
  sig { params(name: String).returns(T.attached_class) }
  def self.for_name(name)
    for_formula(Formulary.factory(name))
  end

  def self.remap_deprecated_options(deprecated_options, options)
    deprecated_options.each do |deprecated_option|
      option = options.find { |o| o.name == deprecated_option.old }
      next unless option

      options -= [option]
      options << Option.new(deprecated_option.current, option.description)
    end
    options
  end

  # Returns a {Tab} for an already installed formula,
  # or a fake one if the formula is not installed.
  sig { params(formula: Formula).returns(T.attached_class) }
  def self.for_formula(formula)
    paths = []

    paths << formula.opt_prefix.resolved_path if formula.opt_prefix.symlink? && formula.opt_prefix.directory?

    paths << formula.linked_keg.resolved_path if formula.linked_keg.symlink? && formula.linked_keg.directory?

    if (dirs = formula.installed_prefixes).length == 1
      paths << dirs.first
    end

    paths << formula.latest_installed_prefix

    path = paths.map { |pathname| pathname/FILENAME }.find(&:file?)

    if path
      tab = from_file(path)
      used_options = remap_deprecated_options(formula.deprecated_options, tab.used_options)
      tab.used_options = used_options.as_flags
    else
      # Formula is not installed. Return a fake tab.
      tab = empty
      tab.unused_options = formula.options.as_flags
      tab.source = {
        "path"         => formula.specified_path.to_s,
        "tap"          => formula.tap&.name,
        "tap_git_head" => formula.tap_git_head,
        "spec"         => formula.active_spec_sym.to_s,
        "versions"     => {
          "stable"         => formula.stable&.version&.to_s,
          "head"           => formula.head&.version&.to_s,
          "version_scheme" => formula.version_scheme,
        },
      }
    end

    tab
  end

  sig { returns(T.attached_class) }
  def self.empty
    tab = super

    tab.used_options = []
    tab.unused_options = []
    tab.built_as_bottle = false
    tab.poured_from_bottle = false
    tab.source_modified_time = 0
    tab.stdlib = nil
    tab.compiler = DevelopmentTools.default_compiler
    tab.aliases = []
    tab.source["spec"] = "stable"
    tab.source["versions"] = empty_source_versions

    tab
  end

  sig { returns(T::Hash[String, T.untyped]) }
  def self.empty_source_versions
    {
      "stable"         => nil,
      "head"           => nil,
      "version_scheme" => 0,
    }
  end
  private_class_method :empty_source_versions

  def self.runtime_deps_hash(formula, deps)
    deps.map do |dep|
      formula_to_dep_hash(dep.to_formula, formula.deps.map(&:name))
    end
  end

  sig { returns(T::Boolean) }
  def any_args_or_options?
    !used_options.empty? || !unused_options.empty?
  end

  def with?(val)
    option_names = val.respond_to?(:option_names) ? val.option_names : [val]

    option_names.any? do |name|
      include?("with-#{name}") || unused_options.include?("without-#{name}")
    end
  end

  def without?(val)
    !with?(val)
  end

  sig { params(opt: String).returns(T::Boolean) }
  def include?(opt)
    used_options.include? opt
  end

  sig { returns(T::Boolean) }
  def head?
    spec == :head
  end

  sig { returns(T::Boolean) }
  def stable?
    spec == :stable
  end

  # The options used to install the formula.
  #
  # @api internal
  sig { returns(Options) }
  def used_options
    Options.create(@used_options)
  end

  sig { returns(Options) }
  def unused_options
    Options.create(@unused_options)
  end

  sig { returns(T.any(String, Symbol)) }
  def compiler
    @compiler || DevelopmentTools.default_compiler
  end

  def runtime_dependencies
    # Homebrew versions prior to 1.1.6 generated incorrect runtime dependency
    # lists.
    @runtime_dependencies if parsed_homebrew_version >= "1.1.6"
  end

  sig { returns(CxxStdlib) }
  def cxxstdlib
    # Older tabs won't have these values, so provide sensible defaults
    lib = stdlib.to_sym if stdlib
    CxxStdlib.create(lib, compiler.to_sym)
  end

  sig { returns(T::Boolean) }
  def built_bottle?
    built_as_bottle && !poured_from_bottle
  end

  sig { returns(T::Boolean) }
  def bottle?
    built_as_bottle
  end

  sig { returns(Symbol) }
  def spec
    source["spec"].to_sym
  end

  sig { returns(T::Hash[String, T.untyped]) }
  def versions
    source["versions"]
  end

  sig { returns(T.nilable(Version)) }
  def stable_version
    versions["stable"]&.then { Version.new(_1) }
  end

  sig { returns(T.nilable(Version)) }
  def head_version
    versions["head"]&.then { Version.new(_1) }
  end

  sig { returns(Integer) }
  def version_scheme
    versions["version_scheme"] || 0
  end

  sig { returns(Time) }
  def source_modified_time
    Time.at(@source_modified_time || 0)
  end

  sig { params(options: T.nilable(T::Hash[String, T.untyped])).returns(String) }
  def to_json(options = nil)
    attributes = {
      "homebrew_version"        => homebrew_version,
      "used_options"            => used_options.as_flags,
      "unused_options"          => unused_options.as_flags,
      "built_as_bottle"         => built_as_bottle,
      "poured_from_bottle"      => poured_from_bottle,
      "loaded_from_api"         => loaded_from_api,
      "installed_as_dependency" => installed_as_dependency,
      "installed_on_request"    => installed_on_request,
      "changed_files"           => changed_files&.map(&:to_s),
      "time"                    => time,
      "source_modified_time"    => source_modified_time.to_i,
      "stdlib"                  => stdlib&.to_s,
      "compiler"                => compiler.to_s,
      "aliases"                 => aliases,
      "runtime_dependencies"    => runtime_dependencies,
      "source"                  => source,
      "arch"                    => arch,
      "built_on"                => built_on,
    }
    attributes.delete("stdlib") if attributes["stdlib"].blank?

    JSON.pretty_generate(attributes, options)
  end

  # A subset of to_json that we care about for bottles.
  sig { returns(T::Hash[String, T.untyped]) }
  def to_bottle_hash
    attributes = {
      "homebrew_version"     => homebrew_version,
      "changed_files"        => changed_files&.map(&:to_s),
      "source_modified_time" => source_modified_time.to_i,
      "stdlib"               => stdlib&.to_s,
      "compiler"             => compiler.to_s,
      "runtime_dependencies" => runtime_dependencies,
      "arch"                 => arch,
      "built_on"             => built_on,
    }
    attributes.delete("stdlib") if attributes["stdlib"].blank?
    attributes
  end

  sig { void }
  def write
    # If this is a new installation, the cache of installed formulae
    # will no longer be valid.
    Formula.clear_cache unless tabfile.exist?

    super
  end

  sig { returns(String) }
  def to_s
    s = []
    s << if poured_from_bottle
      "Poured from bottle"
    else
      "Built from source"
    end

    s << "using the formulae.brew.sh API" if loaded_from_api
    s << Time.at(time).strftime("on %Y-%m-%d at %H:%M:%S") if time

    unless used_options.empty?
      s << "with:"
      s << used_options.to_a.join(" ")
    end
    s.join(" ")
  end
end