Class: FormulaInstaller Private

Inherits:
Object show all
Includes:
FormulaCellarChecks, OS::Mac::FormulaInstaller
Defined in:
extend/os/linux/formula_installer.rb,
formula_installer.rb more...

Overview

This class is part of a private API. This class may only be used in the Homebrew/brew repository. Third parties should avoid using this class if possible, as it may be removed or changed without warning.

Installer for a formula.

Constant Summary collapse

ETC_VAR_DIRS =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

T.let([HOMEBREW_PREFIX/"etc", HOMEBREW_PREFIX/"var"].freeze, T::Array[Pathname])

Constants included from FormulaCellarChecks

FormulaCellarChecks::VALID_LIBRARY_EXTENSIONS

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from FormulaCellarChecks

#check_binary_arches, #check_cpuid_instruction, #check_easy_install_pth, #check_elisp_dirname, #check_elisp_root, #check_env_path, #check_flat_namespace, #check_generic_executables, #check_infopages, #check_jars, #check_linkage, #check_manpages, #check_non_executables, #check_non_libraries, #check_openssl_links, #check_plist, #check_python_framework_links, #check_python_packages, #check_python_symlinks, #check_service_command, #check_shadowed_headers, #check_shim_references, #valid_library_extension?

Constructor Details

#initialize(formula, link_keg: false, installed_as_dependency: false, installed_on_request: false, show_header: false, build_bottle: false, skip_post_install: false, skip_link: false, force_bottle: false, bottle_arch: nil, ignore_deps: false, only_deps: false, include_test_formulae: [], build_from_source_formulae: [], env: nil, git: false, interactive: false, keep_tmp: false, debug_symbols: false, cc: nil, options: Options.new, force: false, overwrite: false, debug: false, quiet: false, verbose: false) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

  • formula (Formula)
  • link_keg (Boolean) (defaults to: false)
  • installed_as_dependency (Boolean) (defaults to: false)
  • installed_on_request (Boolean) (defaults to: false)
  • show_header (Boolean) (defaults to: false)
  • build_bottle (Boolean) (defaults to: false)
  • skip_post_install (Boolean) (defaults to: false)
  • skip_link (Boolean) (defaults to: false)
  • force_bottle (Boolean) (defaults to: false)
  • bottle_arch (String, nil) (defaults to: nil)
  • ignore_deps (Boolean) (defaults to: false)
  • only_deps (Boolean) (defaults to: false)
  • include_test_formulae (Array<Formula>) (defaults to: [])
  • build_from_source_formulae (Array<Formula>) (defaults to: [])
  • env (String, nil) (defaults to: nil)
  • git (Boolean) (defaults to: false)
  • interactive (Boolean) (defaults to: false)
  • keep_tmp (Boolean) (defaults to: false)
  • debug_symbols (Boolean) (defaults to: false)
  • cc (String, nil) (defaults to: nil)
  • options (Options) (defaults to: Options.new)
  • force (Boolean) (defaults to: false)
  • overwrite (Boolean) (defaults to: false)
  • debug (Boolean) (defaults to: false)
  • quiet (Boolean) (defaults to: false)
  • verbose (Boolean) (defaults to: false)
[View source]

77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'formula_installer.rb', line 77

def initialize(
  formula,
  link_keg: false,
  installed_as_dependency: false,
  installed_on_request: false,
  show_header: false,
  build_bottle: false,
  skip_post_install: false,
  skip_link: false,
  force_bottle: false,
  bottle_arch: nil,
  ignore_deps: false,
  only_deps: false,
  include_test_formulae: [],
  build_from_source_formulae: [],
  env: nil,
  git: false,
  interactive: false,
  keep_tmp: false,
  debug_symbols: false,
  cc: nil,
  options: Options.new,
  force: false,
  overwrite: false,
  debug: false,
  quiet: false,
  verbose: false
)
  @formula = formula
  @env = env
  @force = force
  @overwrite = overwrite
  @keep_tmp = keep_tmp
  @debug_symbols = debug_symbols
  @link_keg = T.let(!formula.keg_only? || link_keg, T::Boolean)
  @show_header = show_header
  @ignore_deps = ignore_deps
  @only_deps = only_deps
  @build_from_source_formulae = build_from_source_formulae
  @build_bottle = build_bottle
  @skip_post_install = skip_post_install
  @skip_link = skip_link
  @bottle_arch = bottle_arch
  @formula.force_bottle ||= force_bottle
  @force_bottle = T.let(@formula.force_bottle, T::Boolean)
  @include_test_formulae = include_test_formulae
  @interactive = interactive
  @git = git
  @cc = cc
  @verbose = verbose
  @quiet = quiet
  @debug = debug
  @installed_as_dependency = installed_as_dependency
  @installed_on_request = installed_on_request
  @options = options
  @requirement_messages = T.let([], T::Array[String])
  @poured_bottle = T.let(false, T::Boolean)
  @start_time = T.let(nil, T.nilable(Time))
  @bottle_tab_runtime_dependencies = T.let({}.freeze, T::Hash[String, T::Hash[String, String]])
  @hold_locks = T.let(false, T::Boolean)
  @show_summary_heading = T.let(false, T::Boolean)
  @etc_var_preinstall = T.let([], T::Array[Pathname])

  # Take the original formula instance, which might have been swapped from an API instance to a source instance
  @formula = T.let(T.must(previously_fetched_formula), Formula) if previously_fetched_formula
end

Instance Attribute Details

#bottle_tab_runtime_dependencies ⇒ Hash{String => Hash{String => String}} (readonly)

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:


39
40
41
 
# File 'formula_installer.rb', line 39

def bottle_tab_runtime_dependencies
  @bottle_tab_runtime_dependencies
end

#formula ⇒ Formula (readonly)

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:


36
37
38
 
# File 'formula_installer.rb', line 36

def formula
  @formula
end

#link_keg ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean) 

45
46
47
 
# File 'formula_installer.rb', line 45

def link_keg
  @link_keg
end

#options ⇒ Options

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:


42
43
44
 
# File 'formula_installer.rb', line 42

def options
  @options
end

Class Method Details

.attempted ⇒ Set<Formula>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

[View source]

193
194
195
 
# File 'formula_installer.rb', line 193

def self.attempted
  @attempted ||= T.let(Set.new, T.nilable(T::Set[Formula]))
end

.clear_attempted ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

[View source]

198
199
200
 
# File 'formula_installer.rb', line 198

def self.clear_attempted
  @attempted = T.let(Set.new, T.nilable(T::Set[Formula]))
end

.clear_fetched ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

[View source]

218
219
220
 
# File 'formula_installer.rb', line 218

def self.clear_fetched
  @fetched = T.let(Set.new, T.nilable(T::Set[Formula]))
end

.clear_installed ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

[View source]

208
209
210
 
# File 'formula_installer.rb', line 208

def self.clear_installed
  @installed = T.let(Set.new, T.nilable(T::Set[Formula]))
end

.fetched ⇒ Set<Formula>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

[View source]

213
214
215
 
# File 'formula_installer.rb', line 213

def self.fetched
  @fetched ||= T.let(Set.new, T.nilable(T::Set[Formula]))
end

.installed ⇒ Set<Formula>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

[View source]

203
204
205
 
# File 'formula_installer.rb', line 203

def self.installed
  @installed ||= T.let(Set.new, T.nilable(T::Set[Formula]))
end

.locked ⇒ Array<Formula>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

[View source]

1547
1548
1549
 
# File 'formula_installer.rb', line 1547

def self.locked
  @locked ||= T.let([], T.nilable(T::Array[Formula]))
end

Instance Method Details

#audit_installed ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

[View source]

1538
1539
1540
1541
1542
1543
1544
 
# File 'formula_installer.rb', line 1538

def audit_installed
  unless formula.keg_only?
    problem_if_output(check_env_path(formula.bin))
    problem_if_output(check_env_path(formula.sbin))
  end
  super
end

#build ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

[View source]

1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
 
# File 'formula_installer.rb', line 1041

def build
  FileUtils.rm_rf(formula.logs)

  @start_time = Time.now

  # 1. formulae can modify ENV, so we must ensure that each
  #    installation has a pristine ENV when it starts, forking now is
  #    the easiest way to do this
  args = [
    "nice",
    *HOMEBREW_RUBY_EXEC_ARGS,
    "--",
    HOMEBREW_LIBRARY_PATH/"build.rb",
    formula.specified_path,
  ].concat(build_argv)

  if Sandbox.available?
    sandbox = Sandbox.new
    formula.logs.mkpath
    sandbox.record_log(formula.logs/"build.sandbox.log")
    sandbox.allow_write_path(Dir.home) if interactive?
    sandbox.allow_write_temp_and_cache
    sandbox.allow_write_log(formula)
    sandbox.allow_cvs
    sandbox.allow_fossil
    sandbox.allow_write_xcode
    sandbox.allow_write_cellar(formula)
    sandbox.deny_all_network unless formula.network_access_allowed?(:build)
    sandbox.run(*args)
  else
    Utils.safe_fork do
      exec(*args)
    end
  end

  formula.update_head_version

  raise "Empty installation" if !formula.prefix.directory? || Keg.new(formula.prefix).empty_installation?
# Handle all possible exceptions when building.
rescue Exception => e # rubocop:disable Lint/RescueException
  if e.is_a? BuildError
    e.formula = formula
    e.options = display_options(formula)
  end

  ignore_interrupts do
    # any exceptions must leave us with nothing installed
    formula.update_head_version
    FileUtils.rm_r(formula.prefix) if formula.prefix.directory?
    formula.rack.rmdir_if_possible
  end
  raise e
end

#build_argv ⇒ Array<String>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

[View source]

1038
 
# File 'formula_installer.rb', line 1038

def build_argv = sanitized_argv_options + options.as_flags

#build_bottle? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean)
[View source]

233
234
235
 
# File 'formula_installer.rb', line 233

def build_bottle?
  @build_bottle.present?
end

#build_bottle_postinstall ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

[View source]

471
472
473
474
475
476
 
# File 'formula_installer.rb', line 471

def build_bottle_postinstall
  etc_var_postinstall = Find.find(*ETC_VAR_DIRS.select(&:directory?)).to_a
  (etc_var_postinstall - @etc_var_preinstall).each do |file|
    Pathname.new(file).cp_path_sub(HOMEBREW_PREFIX, formula.bottle_prefix)
  end
end

#build_bottle_preinstall ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

[View source]

466
467
468
 
# File 'formula_installer.rb', line 466

def build_bottle_preinstall
  @etc_var_preinstall = Find.find(*ETC_VAR_DIRS.select(&:directory?)).to_a
end

#build_from_source? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean)
[View source]

223
224
225
 
# File 'formula_installer.rb', line 223

def build_from_source?
  @build_from_source_formulae.include?(formula.full_name)
end

#build_time ⇒ Float?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Float, nil)
[View source]

1000
1001
1002
 
# File 'formula_installer.rb', line 1000

def build_time
  @build_time ||= T.let(Time.now - @start_time, T.nilable(Float)) if @start_time && !interactive?
end

#caveats ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

[View source]

886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
 
# File 'formula_installer.rb', line 886

def caveats
  return if only_deps?

  audit_installed if Homebrew::EnvConfig.developer?

  return if !installed_on_request? || installed_as_dependency?
  return if quiet?

  caveats = Caveats.new(formula)

  return if caveats.empty?

  @show_summary_heading = true
  ohai "Caveats", caveats.to_s
  Homebrew.messages.record_caveats(formula.name, caveats)
end

#check_conflicts ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Raises:

[View source]

585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
 
# File 'formula_installer.rb', line 585

def check_conflicts
  return if force?

  conflicts = formula.conflicts.select do |c|
    f = Formulary.factory(c.name)
  rescue TapFormulaUnavailableError
    # If the formula name is a fully-qualified name let's silently
    # ignore it as we don't care about things used in taps that aren't
    # currently tapped.
    false
  rescue FormulaUnavailableError => e
    # If the formula name doesn't exist any more then complain but don't
    # stop installation from continuing.
    opoo <<~EOS
      #{formula}: #{e.message}
      'conflicts_with "#{c.name}"' should be removed from #{formula.path.basename}.
    EOS

    raise if Homebrew::EnvConfig.developer?

    $stderr.puts "Please report this issue to the #{formula.tap&.full_name} tap".squeeze(" ")
    $stderr.puts " (not Homebrew/* repositories)!" unless formula.core_formula?
    false
  else
    f.linked_keg.exist? && f.opt_prefix.exist?
  end

  raise FormulaConflictError.new(formula, conflicts) unless conflicts.empty?
end

#check_install_sanity ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Raises:

[View source]

348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'formula_installer.rb', line 348

def check_install_sanity
  check_installation_already_attempted

  if force_bottle? && !pour_bottle?
    raise CannotInstallFormulaError, "--force-bottle passed but #{formula.full_name} has no bottle!"
  end

  if Homebrew.default_prefix? &&
     !build_from_source? && !build_bottle? && !formula.head? && formula.tap&.core_tap? &&
     # Integration tests override homebrew-core locations
     ENV["HOMEBREW_INTEGRATION_TEST"].nil? &&
     !pour_bottle?
    message = if !formula.pour_bottle? && formula.pour_bottle_check_unsatisfied_reason
      formula_message = formula.pour_bottle_check_unsatisfied_reason
      formula_message[0] = formula_message[0].downcase

      <<~EOS
        #{formula}: #{formula_message}
      EOS
    # don't want to complain about no bottle available if doing an
    # upgrade/reinstall/dependency install (but do in the case the bottle
    # check fails)
    elsif fresh_install?(formula)
      <<~EOS
        #{formula}: no bottle available!
      EOS
    end

    if message
      message += <<~EOS
        If you're feeling brave, you can try to install from source with:
          brew install --build-from-source #{formula}

        This is a Tier 3 configuration:
          #{Formatter.url("https://docs.brew.sh/Support-Tiers#tier-3")}
        #{Formatter.bold("Do not report any issues to Homebrew/* repositories!")}
        Read the above document instead before opening any issues or PRs.
      EOS
      raise CannotInstallFormulaError, message
    end
  end

  return if ignore_deps?

  if Homebrew::EnvConfig.developer?
    # `recursive_dependencies` trims cyclic dependencies, so we do one level and take the recursive deps of that.
    # Mapping direct dependencies to deeper dependencies in a hash is also useful for the cyclic output below.
    recursive_dep_map = formula.deps.to_h { |dep| [dep, dep.to_formula.recursive_dependencies] }

    cyclic_dependencies = []
    recursive_dep_map.each do |dep, recursive_deps|
      if [formula.name, formula.full_name].include?(dep.name)
        cyclic_dependencies << "#{formula.full_name} depends on itself directly"
      elsif recursive_deps.any? { |rdep| [formula.name, formula.full_name].include?(rdep.name) }
        cyclic_dependencies << "#{formula.full_name} depends on itself via #{dep.name}"
      end
    end

    if cyclic_dependencies.present?
      raise CannotInstallFormulaError, <<~EOS
        #{formula.full_name} contains a recursive dependency on itself:
          #{cyclic_dependencies.join("\n  ")}
      EOS
    end

    # Merge into one list
    recursive_deps = recursive_dep_map.flat_map { |dep, rdeps| [dep] + rdeps }
    Dependency.merge_repeats(recursive_deps)
  else
    recursive_deps = formula.recursive_dependencies
  end

  invalid_arch_dependencies = []
  pinned_unsatisfied_deps = []
  recursive_deps.each do |dep|
    if (tab = Tab.for_formula(dep.to_formula)) && tab.arch.present? && tab.arch.to_s != Hardware::CPU.arch.to_s
      invalid_arch_dependencies << "#{dep} was built for #{tab.arch}"
    end

    next unless dep.to_formula.pinned?
    next if dep.satisfied?(inherited_options_for(dep))
    next if dep.build? && pour_bottle?
    next if dep.test?

    pinned_unsatisfied_deps << dep
  end

  if invalid_arch_dependencies.present?
    raise CannotInstallFormulaError, <<~EOS
      #{formula.full_name} dependencies not built for the #{Hardware::CPU.arch} CPU architecture:
        #{invalid_arch_dependencies.join("\n  ")}
    EOS
  end

  return if pinned_unsatisfied_deps.empty?

  raise CannotInstallFormulaError,
        "You must `brew unpin #{pinned_unsatisfied_deps * " "}` as installing " \
        "#{formula.full_name} requires the latest version of pinned dependencies"
end

#check_installation_already_attempted ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Raises:

[View source]

343
344
345
 
# File 'formula_installer.rb', line 343

def check_installation_already_attempted
  raise FormulaInstallationAlreadyAttemptedError, formula if self.class.attempted.include?(formula)
end

#check_requirements(req_map) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:

Raises:

[View source]

645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
 
# File 'formula_installer.rb', line 645

def check_requirements(req_map)
  @requirement_messages = []
  fatals = []

  req_map.each_pair do |dependent, reqs|
    reqs.each do |req|
      next if dependent.latest_version_installed? && req.is_a?(MacOSRequirement) && req.comparator == "<="

      @requirement_messages << "#{dependent}: #{req.message}"
      fatals << req if req.fatal?
    end
  end

  return if fatals.empty?

  puts_requirement_messages
  raise UnsatisfiedRequirements, fatals
end

#clean ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

[View source]

1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
 
# File 'formula_installer.rb', line 1236

def clean
  ohai "Cleaning" if verbose?
  Cleaner.new(formula).clean
# Handle all possible exceptions when cleaning does not complete.
rescue Exception => e # rubocop:disable Lint/RescueException
  opoo "The cleaning step did not complete successfully"
  puts "Still, the installation was successful, so we will link it into your prefix."

  require "utils/backtrace"
  odebug e, Utils::Backtrace.clean(e)

  Homebrew.failed = true
  @show_summary_heading = true
end

#compute_and_install_dependencies ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

[View source]

639
640
641
642
 
# File 'formula_installer.rb', line 639

def compute_and_install_dependencies
  deps = compute_dependencies
  install_dependencies(deps)
end

#compute_dependencies(use_cache: true) ⇒ Array<Array<(Dependency, Options)>>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Compute and collect the dependencies needed by the formula currently being installed.

Parameters:

  • use_cache (Boolean) (defaults to: true)

Returns:

[View source]

618
619
620
621
622
623
624
625
626
627
 
# File 'formula_installer.rb', line 618

def compute_dependencies(use_cache: true)
  @compute_dependencies = T.let(nil, T.nilable(T::Array[[Dependency, Options]])) unless use_cache
  @compute_dependencies ||= begin
    # Needs to be done before expand_dependencies
    fetch_bottle_tab if pour_bottle?

    check_requirements(expand_requirements)
    expand_dependencies
  end
end

#debug? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean)
[View source]

145
 
# File 'formula_installer.rb', line 145

def debug? = @debug

#debug_symbols? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean)
[View source]

148
 
# File 'formula_installer.rb', line 148

def debug_symbols? = @debug_symbols

#display_options(formula) ⇒ Array<String>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:

[View source]

754
755
756
757
758
759
760
761
762
 
# File 'formula_installer.rb', line 754

def display_options(formula)
  options = if formula.head?
    ["--HEAD"]
  else
    []
  end
  options += effective_build_options_for(formula).used_options.to_a
  options
end

#downloadable ⇒ Downloadable

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

[View source]

1475
1476
1477
1478
1479
1480
1481
1482
1483
 
# File 'formula_installer.rb', line 1475

def downloadable
  if (bottle_path = formula.local_bottle_path)
    Resource::Local.new(bottle_path)
  elsif pour_bottle?
    T.must(formula.bottle)
  else
    T.must(formula.resource)
  end
end

#effective_build_options_for(dependent, inherited_options = Options.new) ⇒ BuildOptions

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

  • dependent (Formula)
  • inherited_options (Options) (defaults to: Options.new)

Returns:

[View source]

745
746
747
748
749
750
751
 
# File 'formula_installer.rb', line 745

def effective_build_options_for(dependent, inherited_options = Options.new)
  args  = dependent.build.used_options
  args |= (dependent == formula) ? options : inherited_options
  args |= Tab.for_formula(dependent).used_options
  args &= dependent.options
  BuildOptions.new(args, dependent.options)
end

#expand_dependencies ⇒ Array<Array<(Dependency, Options)>>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

[View source]

736
737
738
739
740
741
742
 
# File 'formula_installer.rb', line 736

def expand_dependencies
  inherited_options = Hash.new { |hash, key| hash[key] = Options.new }

  expanded_deps = expand_dependencies_for_formula(formula, inherited_options)

  expanded_deps.map { |dep| [dep, inherited_options[dep.name]] }
end

#expand_dependencies_for_formula(formula, inherited_options) ⇒ Array<Dependency>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:

[View source]

707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
 
# File 'formula_installer.rb', line 707

def expand_dependencies_for_formula(formula, inherited_options)
  # Cache for this expansion only. FormulaInstaller has a lot of inputs which can alter expansion.
  cache_key = "FormulaInstaller-#{formula.full_name}-#{Time.now.to_f}"
  Dependency.expand(formula, cache_key:) do |dependent, dep|
    inherited_options[dep.name] |= inherited_options_for(dep)
    build = effective_build_options_for(
      dependent,
      inherited_options.fetch(dependent.name, Options.new),
    )

    keep_build_test = false
    keep_build_test ||= dep.test? && include_test? && @include_test_formulae.include?(dependent.full_name)
    keep_build_test ||= dep.build? && !install_bottle_for?(dependent, build) &&
                        (formula.head? || !dependent.latest_version_installed?)

    bottle_runtime_version = @bottle_tab_runtime_dependencies.dig(dep.name, "version").presence
    bottle_runtime_version = Version.new(bottle_runtime_version) if bottle_runtime_version
    bottle_runtime_revision = @bottle_tab_runtime_dependencies.dig(dep.name, "revision")

    if dep.prune_from_option?(build) || ((dep.build? || dep.test?) && !keep_build_test)
      Dependency.prune
    elsif dep.satisfied?(inherited_options[dep.name], minimum_version:  bottle_runtime_version,
                                                      minimum_revision: bottle_runtime_revision)
      Dependency.skip
    end
  end
end

#expand_requirements ⇒ Hash{Formula => Array<Requirement>}

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

[View source]

674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
 
# File 'formula_installer.rb', line 674

def expand_requirements
  unsatisfied_reqs = Hash.new { |h, k| h[k] = [] }
  formulae = [formula]
  formula_deps_map = formula.recursive_dependencies
                            .each_with_object({}) { |dep, h| h[dep.name] = dep }

  while (f = formulae.pop)
    runtime_requirements = runtime_requirements(f)
    f.recursive_requirements do |dependent, req|
      build = effective_build_options_for(dependent)
      install_bottle_for_dependent = install_bottle_for?(dependent, build)

      keep_build_test = false
      keep_build_test ||= runtime_requirements.include?(req)
      keep_build_test ||= req.test? && include_test? && dependent == f
      keep_build_test ||= req.build? && !install_bottle_for_dependent && !dependent.latest_version_installed?

      if req.prune_from_option?(build) ||
         req.satisfied?(env: @env, cc: @cc, build_bottle: @build_bottle, bottle_arch: @bottle_arch) ||
         ((req.build? || req.test?) && !keep_build_test) ||
         formula_deps_map[dependent.name]&.build? ||
         (only_deps? && f == dependent)
        Requirement.prune
      else
        unsatisfied_reqs[dependent] << req
      end
    end
  end

  unsatisfied_reqs
end

#fetch ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

[View source]

1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
 
# File 'formula_installer.rb', line 1372

def fetch
  return if previously_fetched_formula

  fetch_dependencies

  return if only_deps?
  return if formula.local_bottle_path.present?

  oh1 "Fetching #{Formatter.identifier(formula.full_name)}".strip

  downloadable_object = downloadable
  check_attestation = if pour_bottle?(output_warning: true)
    fetch_bottle_tab

    !downloadable_object.cached_download.exist?
  else
    @formula = Homebrew::API::Formula.source_download(formula) if formula.loaded_from_api?

    formula.fetch_patches
    formula.resources.each(&:fetch)
    downloadable_object = downloadable

    false
  end
  downloadable_object.fetch

  # We skip `gh` to avoid a bootstrapping cycle, in the off-chance a user attempts
  # to explicitly `brew install gh` without already having a version for bootstrapping.
  # We also skip bottle installs from local bottle paths, as these are done in CI
  # as part of the build lifecycle before attestations are produced.
  if check_attestation &&
     Homebrew::Attestation.enabled? &&
     formula.tap&.core_tap? &&
     formula.name != "gh"
    ohai "Verifying attestation for #{formula.name}"
    begin
      Homebrew::Attestation.check_core_attestation T.cast(downloadable_object, Bottle)
    rescue Homebrew::Attestation::GhIncompatible
      # A small but significant number of users have developer mode enabled
      # but *also* haven't upgraded in a long time, meaning that their `gh`
      # version is too old to perform attestations.
      raise CannotInstallFormulaError, <<~EOS
        The bottle for #{formula.name} could not be verified.

        This typically indicates an outdated or incompatible `gh` CLI.

        Please confirm that you're running the latest version of `gh`
        by performing an upgrade before retrying:

          brew update
          brew upgrade gh
      EOS
    rescue Homebrew::Attestation::GhAuthInvalid
      # Only raise an error if we explicitly opted-in to verification.
      raise CannotInstallFormulaError, <<~EOS if Homebrew::EnvConfig.verify_attestations?
        The bottle for #{formula.name} could not be verified.

        This typically indicates an invalid GitHub API token.

        If you have `HOMEBREW_GITHUB_API_TOKEN` set, check it is correct
        or unset it and instead run:

          gh auth login
      EOS

      # If we didn't explicitly opt-in, then quietly opt-out in the case of invalid credentials.
      # Based on user reports, a significant number of users are running with stale tokens.
      ENV["HOMEBREW_NO_VERIFY_ATTESTATIONS"] = "1"
    rescue Homebrew::Attestation::GhAuthNeeded
      raise CannotInstallFormulaError, <<~EOS
        The bottle for #{formula.name} could not be verified.

        This typically indicates a missing GitHub API token, which you
        can resolve either by setting `HOMEBREW_GITHUB_API_TOKEN` or
        by running:

          gh auth login
      EOS
    rescue Homebrew::Attestation::MissingAttestationError, Homebrew::Attestation::InvalidAttestationError => e
      raise CannotInstallFormulaError, <<~EOS
        The bottle for #{formula.name} has an invalid build provenance attestation.

        This may indicate that the bottle was not produced by the expected
        tap, or was maliciously inserted into the expected tap's bottle
        storage.

        Additional context:

        #{e}
      EOS
    end
  end

  self.class.fetched << formula
rescue CannotInstallFormulaError
  if (cached_download = downloadable_object&.cached_download)&.exist?
    cached_download.unlink
  end

  raise
end

#fetch_bottle_tab ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

[View source]

1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
 
# File 'formula_installer.rb', line 1356

def fetch_bottle_tab
  return if @fetch_bottle_tab

  begin
    formula.fetch_bottle_tab
    @bottle_tab_runtime_dependencies = formula.bottle_tab_attributes
                                              .fetch("runtime_dependencies", []).then { |deps| deps || [] }
                                              .each_with_object({}) { |dep, h| h[dep["full_name"]] = dep }
                                              .freeze
  rescue DownloadError, Resource::BottleManifest::Error
    # do nothing
  end
  @fetch_bottle_tab = T.let(true, T.nilable(TrueClass))
end

#fetch_dependencies ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

[View source]

1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
 
# File 'formula_installer.rb', line 1326

def fetch_dependencies
  return if ignore_deps?

  # Don't output dependencies if we're explicitly installing them.
  deps = compute_dependencies.reject do |(dep, _options)|
    self.class.fetched.include?(dep.to_formula)
  end

  return if deps.empty?

  oh1 "Fetching dependencies for #{formula.full_name}: " \
      "#{deps.map(&:first).map { Formatter.identifier(_1) }.to_sentence}",
      truncate: false

  deps.each { |(dep, _options)| fetch_dependency(dep) }
end

#fetch_dependency(dep) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:

[View source]

789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
 
# File 'formula_installer.rb', line 789

def fetch_dependency(dep)
  df = dep.to_formula
  fi = FormulaInstaller.new(
    df,
    force_bottle:               false,
    # When fetching we don't need to recurse the dependency tree as it's already
    # been done for us in `compute_dependencies` and there's no requirement to
    # fetch in a particular order.
    # Note, this tree can vary when pouring bottles so we need to check it then.
    ignore_deps:                !pour_bottle?,
    installed_as_dependency:    true,
    include_test_formulae:      @include_test_formulae,
    build_from_source_formulae: @build_from_source_formulae,
    keep_tmp:                   keep_tmp?,
    debug_symbols:              debug_symbols?,
    force:                      force?,
    debug:                      debug?,
    quiet:                      quiet?,
    verbose:                    verbose?,
  )
  fi.prelude
  fi.fetch
end

#finish ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

[View source]

904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
 
# File 'formula_installer.rb', line 904

def finish
  return if only_deps?

  ohai "Finishing up" if verbose?

  keg = Keg.new(formula.prefix)
  if skip_link?
    unless quiet?
      ohai "Skipping 'link' on request"
      puts "You can run it manually using:"
      puts "  brew link #{formula.full_name}"
    end
  else
    link(keg)
  end

  install_service

  fix_dynamic_linkage(keg) if !@poured_bottle || !formula.bottle_specification.skip_relocation?

  Homebrew::Install.global_post_install

  if build_bottle? || skip_post_install?
    unless quiet?
      if build_bottle?
        ohai "Not running 'post_install' as we're building a bottle"
      elsif skip_post_install?
        ohai "Skipping 'post_install' on request"
      end
      puts "You can run it manually using:"
      puts "  brew postinstall #{formula.full_name}"
    end
  else
    formula.install_etc_var
    post_install if formula.post_install_defined?
  end

  keg.prepare_debug_symbols if debug_symbols?

  # Updates the cache for a particular formula after doing an install
  CacheStoreDatabase.use(:linkage) do |db|
    break unless db.created?

    LinkageChecker.new(keg, formula, cache_db: db, rebuild_cache: true)
  end

  # Update tab with actual runtime dependencies
  tab = keg.tab
  Tab.clear_cache
  f_runtime_deps = formula.runtime_dependencies(read_from_tab: false)
  tab.runtime_dependencies = Tab.runtime_deps_hash(formula, f_runtime_deps)
  tab.write

  # write/update a SBOM file (if we aren't bottling)
  unless build_bottle?
    sbom = SBOM.create(formula, tab)
    sbom.write(validate: Homebrew::EnvConfig.developer?)
  end

  # let's reset Utils::Git.available? if we just installed git
  Utils::Git.clear_available_cache if formula.name == "git"

  # use installed ca-certificates when it's needed and available
  if formula.name == "ca-certificates" &&
     !DevelopmentTools.ca_file_handles_most_https_certificates?
    ENV["SSL_CERT_FILE"] = ENV["GIT_SSL_CAINFO"] = (formula.pkgetc/"cert.pem").to_s
    ENV["GIT_SSL_CAPATH"] = formula.pkgetc.to_s
  end

  # use installed curl when it's needed and available
  if formula.name == "curl" &&
     !DevelopmentTools.curl_handles_most_https_certificates?
    ENV["HOMEBREW_CURL"] = (formula.opt_bin/"curl").to_s
    Utils::Curl.clear_path_cache
  end

  caveats

  ohai "Summary" if verbose? || show_summary_heading?
  puts summary

  self.class.installed << formula
ensure
  unlock
end

#fix_dynamic_linkage(keg) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:

[View source]

1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
 
# File 'formula_installer.rb', line 1220

def fix_dynamic_linkage(keg)
  keg.fix_dynamic_linkage
# Rescue all possible exceptions when fixing linkage.
rescue Exception => e # rubocop:disable Lint/RescueException
  ofail "Failed to fix install linkage"
  puts e
  puts "The formula built, but you may encounter issues using it or linking other"
  puts "formulae against it."

  require "utils/backtrace"
  odebug "Backtrace", Utils::Backtrace.clean(e)

  @show_summary_heading = true
end

#forbidden_formula_check ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Raises:

[View source]

1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
 
# File 'formula_installer.rb', line 1650

def forbidden_formula_check
  forbidden_formulae = Set.new(Homebrew::EnvConfig.forbidden_formulae.to_s.split)
  return if forbidden_formulae.blank?

  owner = Homebrew::EnvConfig.forbidden_owner
  owner_contact = if (contact = Homebrew::EnvConfig.forbidden_owner_contact.presence)
    "\n#{contact}"
  end

  unless ignore_deps?
    compute_dependencies.each do |(dep, _options)|
      dep_name = if forbidden_formulae.include?(dep.name)
        dep.name
      elsif dep.tap.present? &&
            (dep_full_name = "#{dep.tap}/#{dep.name}") &&
            forbidden_formulae.include?(dep_full_name)
        dep_full_name
      else
        next
      end

      raise CannotInstallFormulaError, <<~EOS
        The installation of #{formula.name} has a dependency #{dep_name}
        but the #{dep_name} formula was forbidden by #{owner} in `HOMEBREW_FORBIDDEN_FORMULAE`.#{owner_contact}
      EOS
    end
  end

  return if only_deps?

  formula_name = if forbidden_formulae.include?(formula.name)
    formula.name
  elsif forbidden_formulae.include?(formula.full_name)
    formula.full_name
  else
    return
  end

  raise CannotInstallFormulaError, <<~EOS
    The installation of #{formula_name} was forbidden by #{owner}
    in `HOMEBREW_FORBIDDEN_FORMULAE`.#{owner_contact}
  EOS
end

#forbidden_license_check ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Raises:

[View source]

1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
 
# File 'formula_installer.rb', line 1552

def forbidden_license_check
  forbidden_licenses = Homebrew::EnvConfig.forbidden_licenses.to_s.dup
  SPDX::ALLOWED_LICENSE_SYMBOLS.each do |s|
    pattern = /#{s.to_s.tr("_", " ")}/i
    forbidden_licenses.sub!(pattern, s.to_s)
  end

  invalid_licenses = []
  forbidden_licenses = forbidden_licenses.split.each_with_object({}) do |license, hash|
    unless SPDX.valid_license?(license)
      invalid_licenses << license
      next
    end

    hash[license] = SPDX.license_version_info(license)
  end

  if invalid_licenses.present?
    opoo <<~EOS
      HOMEBREW_FORBIDDEN_LICENSES contains invalid license identifiers: #{invalid_licenses.to_sentence}
      These licenses will not be forbidden. See the valid SPDX license identifiers at:
        #{Formatter.url("https://spdx.org/licenses/")}
      And the licenses for a formula with:
        brew info <formula>
    EOS
  end

  return if forbidden_licenses.blank?

  owner = Homebrew::EnvConfig.forbidden_owner
  owner_contact = if (contact = Homebrew::EnvConfig.forbidden_owner_contact.presence)
    "\n#{contact}"
  end

  unless ignore_deps?
    compute_dependencies.each do |(dep, _options)|
      dep_f = dep.to_formula
      next unless SPDX.licenses_forbid_installation? dep_f.license, forbidden_licenses

      raise CannotInstallFormulaError, <<~EOS
        The installation of #{formula.name} has a dependency on #{dep.name} where all
        its licenses were forbidden by #{owner} in `HOMEBREW_FORBIDDEN_LICENSES`:
          #{SPDX.license_expression_to_string dep_f.license}#{owner_contact}
      EOS
    end
  end

  return if only_deps?

  return unless SPDX.licenses_forbid_installation? formula.license, forbidden_licenses

  raise CannotInstallFormulaError, <<~EOS
    #{formula.name}'s licenses are all forbidden by #{owner} in `HOMEBREW_FORBIDDEN_LICENSES`:
      #{SPDX.license_expression_to_string formula.license}#{owner_contact}
  EOS
end

#forbidden_tap_check ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Raises:

[View source]

1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
 
# File 'formula_installer.rb', line 1610

def forbidden_tap_check
  return if Tap.allowed_taps.blank? && Tap.forbidden_taps.blank?

  owner = Homebrew::EnvConfig.forbidden_owner
  owner_contact = if (contact = Homebrew::EnvConfig.forbidden_owner_contact.presence)
    "\n#{contact}"
  end

  unless ignore_deps?
    compute_dependencies.each do |(dep, _options)|
      dep_tap = dep.tap
      next if dep_tap.blank? || (dep_tap.allowed_by_env? && !dep_tap.forbidden_by_env?)

      error_message = "The installation of #{formula.name} has a dependency #{dep.name}\n" \
                      "from the #{dep_tap} tap but #{owner} "
      error_message << "has not allowed this tap in `HOMEBREW_ALLOWED_TAPS`" unless dep_tap.allowed_by_env?
      error_message << " and\n" if !dep_tap.allowed_by_env? && dep_tap.forbidden_by_env?
      error_message << "has forbidden this tap in `HOMEBREW_FORBIDDEN_TAPS`" if dep_tap.forbidden_by_env?
      error_message << ".#{owner_contact}"

      raise CannotInstallFormulaError, error_message
    end
  end

  return if only_deps?

  formula_tap = formula.tap
  return if formula_tap.blank? || (formula_tap.allowed_by_env? && !formula_tap.forbidden_by_env?)

  error_message = "The installation of #{formula.full_name} has the tap #{formula_tap}\n" \
                  "but #{owner} "
  error_message << "has not allowed this tap in `HOMEBREW_ALLOWED_TAPS`" unless formula_tap.allowed_by_env?
  error_message << " and\n" if !formula_tap.allowed_by_env? && formula_tap.forbidden_by_env?
  error_message << "has forbidden this tap in `HOMEBREW_FORBIDDEN_TAPS`" if formula_tap.forbidden_by_env?
  error_message << ".#{owner_contact}"

  raise CannotInstallFormulaError, error_message
end

#force? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean)
[View source]

151
 
# File 'formula_installer.rb', line 151

def force? = @force

#force_bottle? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean)
[View source]

154
 
# File 'formula_installer.rb', line 154

def force_bottle? = @force_bottle

#fresh_install?(formula) ⇒ Boolean?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:

  • (Boolean, nil)
[View source]

6
7
8
9
 
# File 'extend/os/linux/formula_installer.rb', line 6

def fresh_install?(formula)
  !Homebrew::EnvConfig.developer? &&
    (!installed_as_dependency? || !formula.any_version_installed?)
end

#git? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean)
[View source]

157
 
# File 'formula_installer.rb', line 157

def git? = @git

#ignore_deps? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean)
[View source]

160
 
# File 'formula_installer.rb', line 160

def ignore_deps? = @ignore_deps

#include_test? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean)
[View source]

228
229
230
 
# File 'formula_installer.rb', line 228

def include_test?
  @include_test_formulae.include?(formula.full_name)
end

#inherited_options_for(dep) ⇒ Options

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:

[View source]

765
766
767
768
769
770
771
772
 
# File 'formula_installer.rb', line 765

def inherited_options_for(dep)
  inherited_options = Options.new
  u = Option.new("universal")
  if (options.include?(u) || formula.require_universal_deps?) && !dep.build? && dep.to_formula.option_defined?(u)
    inherited_options << u
  end
  inherited_options
end

#install ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Raises:

[View source]

479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'formula_installer.rb', line 479

def install
  lock

  start_time = Time.now
  Homebrew::Install.perform_build_from_source_checks if !pour_bottle? && DevelopmentTools.installed?

  # Warn if a more recent version of this formula is available in the tap.
  begin
    if !quiet? &&
       formula.pkg_version < (v = Formulary.factory(formula.full_name, force_bottle: force_bottle?).pkg_version)
      opoo "#{formula.full_name} #{v} is available and more recent than version #{formula.pkg_version}."
    end
  rescue FormulaUnavailableError
    nil
  end

  check_conflicts

  raise UnbottledError, [formula] if !pour_bottle? && !DevelopmentTools.installed?

  unless ignore_deps?
    deps = compute_dependencies(use_cache: false)
    if ((pour_bottle? && !DevelopmentTools.installed?) || build_bottle?) &&
       (unbottled = unbottled_dependencies(deps)).presence
      # Check that each dependency in deps has a bottle available, terminating
      # abnormally with a UnbottledError if one or more don't.
      raise UnbottledError, unbottled
    end

    install_dependencies(deps)
  end

  return if only_deps?

  formula.deprecated_flags.each do |deprecated_option|
    old_flag = deprecated_option.old_flag
    new_flag = deprecated_option.current_flag
    opoo "#{formula.full_name}: #{old_flag} was deprecated; using #{new_flag} instead!"
  end

  options = display_options(formula).join(" ")
  oh1 "Installing #{Formatter.identifier(formula.full_name)} #{options}".strip if show_header?

  if (tap = formula.tap) && tap.should_report_analytics?
    Utils::Analytics.report_package_event(:formula_install, package_name: formula.name, tap_name: tap.name,
on_request: installed_on_request?, options:)
  end

  self.class.attempted << formula

  if pour_bottle?
    begin
      pour
    # Catch any other types of exceptions as they leave us with nothing installed.
    rescue Exception # rubocop:disable Lint/RescueException
      ignore_interrupts do
        begin
          FileUtils.rm_r(formula.prefix) if formula.prefix.directory?
        rescue Errno::EACCES, Errno::ENOTEMPTY
          odie <<~EOS
            Could not remove #{formula.prefix.basename} keg! Do so manually:
              sudo rm -rf #{formula.prefix}
          EOS
        end
        formula.rack.rmdir_if_possible
      end
      raise
    else
      @poured_bottle = true
    end
  end

  puts_requirement_messages

  build_bottle_preinstall if build_bottle?

  unless @poured_bottle
    build
    clean

    # Store the formula used to build the keg in the keg.
    formula_contents = if formula.local_bottle_path
      Utils::Bottles.formula_contents formula.local_bottle_path, name: formula.name
    else
      formula.path.read
    end
    s = formula_contents.gsub(/  bottle do.+?end\n\n?/m, "")
    brew_prefix = formula.prefix/".brew"
    brew_prefix.mkpath
    Pathname(brew_prefix/"#{formula.name}.rb").atomic_write(s)

    keg = Keg.new(formula.prefix)
    tab = keg.tab
    tab.installed_as_dependency = installed_as_dependency?
    tab.installed_on_request = installed_on_request?
    tab.write
  end

  build_bottle_postinstall if build_bottle?

  opoo "Nothing was installed to #{formula.prefix}" unless formula.latest_version_installed?
  end_time = Time.now
  Homebrew.messages.package_installed(formula.name, end_time - start_time)
end

#install_bottle_for?(dep, build) ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:

  • (Boolean)
[View source]

286
287
288
289
290
291
292
293
294
 
# File 'formula_installer.rb', line 286

def install_bottle_for?(dep, build)
  return pour_bottle? if dep == formula

  @build_from_source_formulae.exclude?(dep.full_name) &&
    dep.bottle.present? &&
    dep.pour_bottle? &&
    build.used_options.empty? &&
    dep.bottle&.compatible_locations?
end

#install_dependencies(deps) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:

[View source]

775
776
777
778
779
780
781
782
783
784
785
786
 
# File 'formula_installer.rb', line 775

def install_dependencies(deps)
  if deps.empty? && only_deps?
    puts "All dependencies for #{formula.full_name} are satisfied."
  elsif !deps.empty?
    oh1 "Installing dependencies for #{formula.full_name}: " \
        "#{deps.map(&:first).map { Formatter.identifier(_1) }.to_sentence}",
        truncate: false
    deps.each { |dep, options| install_dependency(dep, options) }
  end

  @show_header = true unless deps.empty?
end

#install_dependency(dep, inherited_options) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:

[View source]

814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
 
# File 'formula_installer.rb', line 814

def install_dependency(dep, inherited_options)
  df = dep.to_formula

  if df.linked_keg.directory?
    linked_keg = Keg.new(df.linked_keg.resolved_path)
    tab = linked_keg.tab
    keg_had_linked_keg = true
    keg_was_linked = linked_keg.linked?
    linked_keg.unlink
  else
    keg_had_linked_keg = false
  end

  if df.latest_version_installed?
    installed_keg = Keg.new(df.prefix)
    tab ||= installed_keg.tab
    tmp_keg = Pathname.new("#{installed_keg}.tmp")
    installed_keg.rename(tmp_keg)
  end

  if df.tap.present? && tab.present? && (tab_tap = tab.source["tap"].presence) &&
     df.tap.to_s != tab_tap.to_s
    odie <<~EOS
      #{df} is already installed from #{tab_tap}!
      Please `brew uninstall #{df}` first."
    EOS
  end

  options = Options.new
  options |= tab.used_options if tab.present?
  options |= Tab.remap_deprecated_options(df.deprecated_options, dep.options)
  options |= inherited_options
  options &= df.options

  installed_on_request = df.any_version_installed? && tab.present? && tab.installed_on_request
  installed_on_request ||= false

  fi = FormulaInstaller.new(
    df,
    options:,
    link_keg:                   keg_had_linked_keg && keg_was_linked,
    installed_as_dependency:    true,
    installed_on_request:,
    force_bottle:               false,
    include_test_formulae:      @include_test_formulae,
    build_from_source_formulae: @build_from_source_formulae,
    keep_tmp:                   keep_tmp?,
    debug_symbols:              debug_symbols?,
    force:                      force?,
    debug:                      debug?,
    quiet:                      quiet?,
    verbose:                    verbose?,
  )
  oh1 "Installing #{formula.full_name} dependency: #{Formatter.identifier(dep.name)}"
  fi.install
  fi.finish
# Handle all possible exceptions installing deps.
rescue Exception => e # rubocop:disable Lint/RescueException
  ignore_interrupts do
    tmp_keg.rename(installed_keg.to_path) if tmp_keg && !installed_keg.directory?
    linked_keg.link(verbose: verbose?) if keg_was_linked
  end
  raise unless e.is_a? FormulaInstallationAlreadyAttemptedError

  # We already attempted to install f as part of another formula's
  # dependency tree. In that case, don't generate an error, just move on.
  nil
else
  ignore_interrupts { FileUtils.rm_r(tmp_keg) if tmp_keg&.directory? }
end

#install_fetch_deps ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

[View source]

453
454
455
456
457
458
459
460
461
462
463
 
# File 'formula_installer.rb', line 453

def install_fetch_deps
  return if @compute_dependencies.blank?

  compute_dependencies(use_cache: false) if @compute_dependencies.any? do |dep, options|
    next false unless dep.implicit?

    fetch_dependencies
    install_dependency(dep, options)
    true
  end
end

#install_service ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

[View source]

1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
 
# File 'formula_installer.rb', line 1189

def install_service
  service = if formula.service? && formula.service.command?
    service_path = formula.systemd_service_path
    service_path.atomic_write(formula.service.to_systemd_unit)
    service_path.chmod 0644

    if formula.service.timed?
      timer_path = formula.systemd_timer_path
      timer_path.atomic_write(formula.service.to_systemd_timer)
      timer_path.chmod 0644
    end

    formula.service.to_plist
  end
  return unless service

  launchd_service_path = formula.launchd_service_path
  launchd_service_path.atomic_write(service)
  launchd_service_path.chmod 0644
  log = formula.var/"log"
  log.mkpath if service.include? log.to_s
# Handle all possible exceptions when installing service files.
rescue Exception => e # rubocop:disable Lint/RescueException
  puts e
  ofail "Failed to install service files"

  require "utils/backtrace"
  odebug e, Utils::Backtrace.clean(e)
end

#installed_as_dependency? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean)
[View source]

163
 
# File 'formula_installer.rb', line 163

def installed_as_dependency? = @installed_as_dependency

#installed_on_request? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean)
[View source]

166
 
# File 'formula_installer.rb', line 166

def installed_on_request? = @installed_on_request

#interactive? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean)
[View source]

169
 
# File 'formula_installer.rb', line 169

def interactive? = @interactive

#keep_tmp? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean)
[View source]

172
 
# File 'formula_installer.rb', line 172

def keep_tmp? = @keep_tmp

#link(keg) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:

[View source]

1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
 
# File 'formula_installer.rb', line 1096

def link(keg)
  Formula.clear_cache

  unless link_keg
    begin
      keg.optlink(verbose: verbose?, overwrite: overwrite?)
    rescue Keg::LinkError => e
      ofail "Failed to create #{formula.opt_prefix}"
      puts "Things that depend on #{formula.full_name} will probably not build."
      puts e
    end
    return
  end

  cask_installed_with_formula_name = begin
    Cask::CaskLoader.load(formula.name, warn: false).installed?
  rescue Cask::CaskUnavailableError, Cask::CaskInvalidError
    false
  end

  if cask_installed_with_formula_name
    ohai "#{formula.name} cask is installed, skipping link."
    return
  end

  if keg.linked?
    opoo "This keg was marked linked already, continuing anyway"
    keg.remove_linked_keg_record
  end

  Homebrew::Unlink.unlink_versioned_formulae(formula, verbose: verbose?)

  link_overwrite_backup = {} # Hash: conflict file -> backup file
  backup_dir = HOMEBREW_CACHE/"Backup"

  begin
    keg.link(verbose: verbose?, overwrite: overwrite?)
  rescue Keg::ConflictError => e
    conflict_file = e.dst
    if formula.link_overwrite?(conflict_file) && !link_overwrite_backup.key?(conflict_file)
      backup_file = backup_dir/conflict_file.relative_path_from(HOMEBREW_PREFIX).to_s
      backup_file.parent.mkpath
      FileUtils.mv conflict_file, backup_file
      link_overwrite_backup[conflict_file] = backup_file
      retry
    end
    ofail "The `brew link` step did not complete successfully"
    puts "The formula built, but is not symlinked into #{HOMEBREW_PREFIX}"
    puts e
    puts
    puts "Possible conflicting files are:"
    keg.link(dry_run: true, overwrite: true, verbose: verbose?)
    @show_summary_heading = true
  rescue Keg::LinkError => e
    ofail "The `brew link` step did not complete successfully"
    puts "The formula built, but is not symlinked into #{HOMEBREW_PREFIX}"
    puts e
    puts
    puts "You can try again using:"
    puts "  brew link #{formula.name}"
    @show_summary_heading = true
  # Handle all other possible exceptions when linking.
  rescue Exception => e # rubocop:disable Lint/RescueException
    ofail "An unexpected error occurred during the `brew link` step"
    puts "The formula built, but is not symlinked into #{HOMEBREW_PREFIX}"
    puts e

    if debug?
      require "utils/backtrace"
      puts Utils::Backtrace.clean(e)
    end

    @show_summary_heading = true
    ignore_interrupts do
      keg.unlink
      link_overwrite_backup.each do |origin, backup|
        origin.parent.mkpath
        FileUtils.mv backup, origin
      end
    end
    raise
  end

  return if link_overwrite_backup.empty?

  opoo "These files were overwritten during the `brew link` step:"
  puts link_overwrite_backup.keys
  puts
  puts "They have been backed up to: #{backup_dir}"
  @show_summary_heading = true
end

#only_deps? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean)
[View source]

175
 
# File 'formula_installer.rb', line 175

def only_deps? = @only_deps

#overwrite? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean)
[View source]

178
 
# File 'formula_installer.rb', line 178

def overwrite? = @overwrite

#post_install ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

[View source]

1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
 
# File 'formula_installer.rb', line 1282

def post_install
  args = [
    "nice",
    *HOMEBREW_RUBY_EXEC_ARGS,
    "-I", $LOAD_PATH.join(File::PATH_SEPARATOR),
    "--",
    HOMEBREW_LIBRARY_PATH/"postinstall.rb"
  ]

  args << post_install_formula_path

  if Sandbox.available?
    sandbox = Sandbox.new
    formula.logs.mkpath
    sandbox.record_log(formula.logs/"postinstall.sandbox.log")
    sandbox.allow_write_temp_and_cache
    sandbox.allow_write_log(formula)
    sandbox.allow_write_xcode
    sandbox.deny_write_homebrew_repository
    sandbox.allow_write_cellar(formula)
    sandbox.deny_all_network unless formula.network_access_allowed?(:postinstall)
    Keg.keg_link_directories.each do |dir|
      sandbox.allow_write_path "#{HOMEBREW_PREFIX}/#{dir}"
    end
    sandbox.run(*args)
  else
    Utils.safe_fork do
      exec(*args)
    end
  end
# Handle all possible exceptions when postinstall does not complete.
rescue Exception => e # rubocop:disable Lint/RescueException
  opoo "The post-install step did not complete successfully"
  puts "You can try again using:"
  puts "  brew postinstall #{formula.full_name}"

  require "utils/backtrace"
  odebug e, Utils::Backtrace.clean(e), always_display: Homebrew::EnvConfig.developer?

  Homebrew.failed = true
  @show_summary_heading = true
end

#post_install_formula_path ⇒ Pathname

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

[View source]

1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
 
# File 'formula_installer.rb', line 1252

def post_install_formula_path
  # Use the formula from the keg when any of the following is true:
  # * We're installing from the JSON API
  # * We're installing a local bottle file
  # * The formula doesn't exist in the tap (or the tap isn't installed)
  # * The formula in the tap has a different `pkg_version``.
  #
  # In all other cases, including if the formula from the keg is unreadable
  # (third-party taps may `require` some of their own libraries) or if there
  # is no formula present in the keg (as is the case with very old bottles),
  # use the formula from the tap.
  keg_formula_path = formula.opt_prefix/".brew/#{formula.name}.rb"
  return keg_formula_path if formula.loaded_from_api?
  return keg_formula_path if formula.local_bottle_path.present?

  tap_formula_path = T.must(formula.specified_path)
  return keg_formula_path unless tap_formula_path.exist?

  begin
    keg_formula = Formulary.factory(keg_formula_path)
    tap_formula = Formulary.factory(tap_formula_path)
    return keg_formula_path if keg_formula.pkg_version != tap_formula.pkg_version

    tap_formula_path
  rescue FormulaUnavailableError, FormulaUnreadableError
    tap_formula_path
  end
end

#pour ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

[View source]

1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
 
# File 'formula_installer.rb', line 1486

def pour
  HOMEBREW_CELLAR.cd do
    downloadable.downloader.stage
  end

  Tab.clear_cache

  tab = Utils::Bottles.load_tab(formula)

  # fill in missing/outdated parts of the tab
  # keep in sync with Tab#to_bottle_hash
  tab.used_options = []
  tab.unused_options = []
  tab.built_as_bottle = true
  tab.poured_from_bottle = true
  tab.loaded_from_api = formula.loaded_from_api?
  tab.installed_as_dependency = installed_as_dependency?
  tab.installed_on_request = installed_on_request?
  tab.time = Time.now.to_i
  tab.aliases = formula.aliases
  tab.arch = Hardware::CPU.arch
  tab.source["versions"]["stable"] = T.must(formula.stable).version&.to_s
  tab.source["versions"]["version_scheme"] = formula.version_scheme
  tab.source["path"] = formula.specified_path.to_s
  tab.source["tap_git_head"] = formula.tap&.installed? ? formula.tap&.git_head : nil
  tab.tap = formula.tap
  tab.write

  keg = Keg.new(formula.prefix)
  skip_linkage = formula.bottle_specification.skip_relocation?
  keg.replace_placeholders_with_locations(tab.changed_files, skip_linkage:)

  cellar = formula.bottle_specification.tag_to_cellar(Utils::Bottles.tag)
  return if [:any, :any_skip_relocation].include?(cellar)

  prefix = Pathname(cellar).parent.to_s
  return if cellar == HOMEBREW_CELLAR.to_s && prefix == HOMEBREW_PREFIX.to_s

  return unless ENV["HOMEBREW_RELOCATE_BUILD_PREFIX"]

  keg.relocate_build_prefix(keg, prefix, HOMEBREW_PREFIX)
end

#pour_bottle?(output_warning: false) ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

  • output_warning (Boolean) (defaults to: false)

Returns:

  • (Boolean)
[View source]

248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'formula_installer.rb', line 248

def pour_bottle?(output_warning: false)
  return false if !formula.bottle_tag? && !formula.local_bottle_path
  return true  if force_bottle?
  return false if build_from_source? || build_bottle? || interactive?
  return false if @cc
  return false unless options.empty?

  unless formula.pour_bottle?
    if output_warning && formula.pour_bottle_check_unsatisfied_reason
      opoo <<~EOS
        Building #{formula.full_name} from source:
          #{formula.pour_bottle_check_unsatisfied_reason}
      EOS
    end
    return false
  end

  return true if formula.local_bottle_path.present?

  bottle = formula.bottle_for_tag(Utils::Bottles.tag)
  return false if bottle.nil?

  unless bottle.compatible_locations?
    if output_warning
      prefix = Pathname(bottle.cellar.to_s).parent
      opoo <<~EOS
        Building #{formula.full_name} from source as the bottle needs:
        - HOMEBREW_CELLAR: #{bottle.cellar} (yours is #{HOMEBREW_CELLAR})
        - HOMEBREW_PREFIX: #{prefix} (yours is #{HOMEBREW_PREFIX})
      EOS
    end
    return false
  end

  true
end

#prelude ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

[View source]

297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'formula_installer.rb', line 297

def prelude
  deprecate_disable_type = DeprecateDisable.type(formula)
  if deprecate_disable_type.present?
    message = "#{formula.full_name} has been #{DeprecateDisable.message(formula)}"

    case deprecate_disable_type
    when :deprecated
      opoo message
    when :disabled
      if force?
        opoo message
      else
        GitHub::Actions.puts_annotation_if_env_set(:error, message)
        raise CannotInstallFormulaError, message
      end
    end
  end

  Tab.clear_cache

  verify_deps_exist unless ignore_deps?

  forbidden_license_check
  forbidden_tap_check
  forbidden_formula_check

  check_install_sanity
  install_fetch_deps unless ignore_deps?
end

#previously_fetched_formula ⇒ Formula?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

[View source]

1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
 
# File 'formula_installer.rb', line 1344

def previously_fetched_formula
  # We intentionally don't compare classes here:
  # from-API-JSON and from-source formula classes are not equal but we
  # want to equate them to be the same thing here given mixing bottle and
  # from-source installs of the same formula within the same operation
  # doesn't make sense.
  self.class.fetched.find do |fetched_formula|
    fetched_formula.full_name == formula.full_name && fetched_formula.active_spec_sym == formula.active_spec_sym
  end
end

#problem_if_output(output) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:

[View source]

1530
1531
1532
1533
1534
1535
 
# File 'formula_installer.rb', line 1530

def problem_if_output(output)
  return unless output

  opoo output
  @show_summary_heading = true
end

#quiet? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean)
[View source]

181
 
# File 'formula_installer.rb', line 181

def quiet? = @quiet

#runtime_requirements(formula) ⇒ Array<Requirement>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:

[View source]

665
666
667
668
669
670
671
 
# File 'formula_installer.rb', line 665

def runtime_requirements(formula)
  runtime_deps = formula.runtime_formula_dependencies(undeclared: false)
  recursive_requirements = formula.recursive_requirements do |dependent, _|
    Requirement.prune unless runtime_deps.include?(dependent)
  end
  (recursive_requirements.to_a + formula.requirements.to_a).reject(&:build?).uniq
end

#sanitized_argv_options ⇒ Array<String>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

[View source]

1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
 
# File 'formula_installer.rb', line 1005

def sanitized_argv_options
  args = []
  args << "--ignore-dependencies" if ignore_deps?

  if build_bottle?
    args << "--build-bottle"
    args << "--bottle-arch=#{@bottle_arch}" if @bottle_arch
  end

  args << "--git" if git?
  args << "--interactive" if interactive?
  args << "--verbose" if verbose?
  args << "--debug" if debug?
  args << "--cc=#{@cc}" if @cc
  args << "--keep-tmp" if keep_tmp?

  if debug_symbols?
    args << "--debug-symbols"
    args << "--build-from-source"
  end

  if @env.present?
    args << "--env=#{@env}"
  elsif formula.env.std? || formula.deps.select(&:build?).any? { |d| d.name == "scons" }
    args << "--env=std"
  end

  args << "--HEAD" if formula.head?

  args
end

#show_header? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean)
[View source]

184
 
# File 'formula_installer.rb', line 184

def show_header? = @show_header

#show_summary_heading? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean)
[View source]

187
 
# File 'formula_installer.rb', line 187

def show_summary_heading? = @show_summary_heading

#skip_link? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean)
[View source]

243
244
245
 
# File 'formula_installer.rb', line 243

def skip_link?
  @skip_link.present?
end

#skip_post_install? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean)
[View source]

238
239
240
 
# File 'formula_installer.rb', line 238

def skip_post_install?
  @skip_post_install.present?
end

#summary ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

[View source]

991
992
993
994
995
996
997
 
# File 'formula_installer.rb', line 991

def summary
  s = +""
  s << "#{Homebrew::EnvConfig.install_badge}  " unless Homebrew::EnvConfig.no_emoji?
  s << "#{formula.prefix.resolved_path}: #{formula.prefix.abv}"
  s << ", built in #{pretty_duration build_time}" if build_time
  s.freeze
end

#unbottled_dependencies(deps) ⇒ Array<Formula>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:

[View source]

630
631
632
633
634
635
636
 
# File 'formula_installer.rb', line 630

def unbottled_dependencies(deps)
  deps.map { |(dep, _options)| dep.to_formula }.reject do |dep_f|
    next false unless dep_f.pour_bottle?

    dep_f.bottled?
  end
end

#verbose? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean)
[View source]

190
 
# File 'formula_installer.rb', line 190

def verbose? = @verbose

#verify_deps_exist ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

[View source]

328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'formula_installer.rb', line 328

def verify_deps_exist
  begin
    compute_dependencies
  rescue TapFormulaUnavailableError => e
    raise if e.tap.installed?

    e.tap.ensure_installed!
    retry if e.tap.installed? # It may have not installed if it's a core tap.
  end
rescue FormulaUnavailableError => e
  e.dependent = formula.full_name
  raise
end