Class: FormulaInstaller Private

Inherits:
Object
  • Object
show all
Extended by:
Predicable
Includes:
FormulaCellarChecks
Defined in:
formula_installer.rb

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

Constants included from FormulaCellarChecks

FormulaCellarChecks::VALID_LIBRARY_EXTENSIONS

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Predicable

attr_predicate

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: true, show_header: false, build_bottle: 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) ⇒ FormulaInstaller

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 a new instance of FormulaInstaller.



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# File 'formula_installer.rb', line 45

def initialize(
  formula,
  link_keg: false,
  installed_as_dependency: false,
  installed_on_request: true,
  show_header: false,
  build_bottle: 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 = !formula.keg_only? || link_keg
  @show_header = show_header
  @ignore_deps = ignore_deps
  @only_deps = only_deps
  @build_from_source_formulae = build_from_source_formulae
  @build_bottle = build_bottle
  @bottle_arch = bottle_arch
  @formula.force_bottle ||= force_bottle
  @force_bottle = @formula.force_bottle
  @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 = []
  @poured_bottle = false
  @start_time = nil
end

Instance Attribute Details

#formulaObject (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.



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

def formula
  @formula
end

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.



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

def link_keg
  @link_keg
end

#optionsObject

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.



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

def options
  @options
end

Class Method Details

.attemptedObject

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.



101
102
103
# File 'formula_installer.rb', line 101

def self.attempted
  @attempted ||= Set.new
end

.clear_attemptedvoid

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.



106
107
108
# File 'formula_installer.rb', line 106

def self.clear_attempted
  @attempted = Set.new
end

.clear_fetchedvoid

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.



124
125
126
# File 'formula_installer.rb', line 124

def self.clear_fetched
  @fetched = Set.new
end

.clear_installedvoid

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.



115
116
117
# File 'formula_installer.rb', line 115

def self.clear_installed
  @installed = Set.new
end

.fetchedObject

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.



119
120
121
# File 'formula_installer.rb', line 119

def self.fetched
  @fetched ||= Set.new
end

.installedObject

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.



110
111
112
# File 'formula_installer.rb', line 110

def self.installed
  @installed ||= Set.new
end

.lockedObject

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.



1249
1250
1251
# File 'formula_installer.rb', line 1249

def self.locked
  @locked ||= []
end

Instance Method Details

#audit_installedObject

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.



1241
1242
1243
1244
1245
1246
1247
# File 'formula_installer.rb', line 1241

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

#buildvoid

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.



883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
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
# File 'formula_installer.rb', line 883

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)

  Utils.safe_fork do
    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.exec(*args)
    else
      exec(*args)
    end
  end

  formula.update_head_version

  raise "Empty installation" if !formula.prefix.directory? || Keg.new(formula.prefix).empty_installation?
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
    formula.prefix.rmtree if formula.prefix.directory?
    formula.rack.rmdir_if_possible
  end
  raise e
end

#build_argvArray<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:



878
879
880
# File 'formula_installer.rb', line 878

def build_argv
  sanitized_argv_options + options.as_flags
end

#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)


139
140
141
# File 'formula_installer.rb', line 139

def build_bottle?
  @build_bottle.present?
end

#build_bottle_postinstallObject

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.



358
359
360
361
362
363
# File 'formula_installer.rb', line 358

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_preinstallObject

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.



353
354
355
356
# File 'formula_installer.rb', line 353

def build_bottle_preinstall
  @etc_var_dirs ||= [HOMEBREW_PREFIX/"etc", HOMEBREW_PREFIX/"var"]
  @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)


129
130
131
# File 'formula_installer.rb', line 129

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

#build_timeObject

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.



840
841
842
# File 'formula_installer.rb', line 840

def build_time
  @build_time ||= Time.now - @start_time if @start_time && !interactive?
end

#caveatsvoid

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.



749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
# File 'formula_installer.rb', line 749

def caveats
  return if only_deps?

  audit_installed if Homebrew::EnvConfig.developer?

  return if !installed_on_request? || installed_as_dependency?

  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_conflictsObject

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.



472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
# File 'formula_installer.rb', line 472

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} tap (not Homebrew/brew or Homebrew/core)!"
    false
  else
    f.linked_keg.exist? && f.opt_prefix.exist?
  end

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

#check_install_sanityObject

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.



239
240
241
242
243
244
245
246
247
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
284
285
286
287
288
289
290
291
292
293
294
295
296
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
326
327
328
329
330
331
332
333
334
335
336
337
338
# File 'formula_installer.rb', line 239

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_TEST_TMPDIR"].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 !Homebrew::EnvConfig.developer? &&
          (!installed_as_dependency? || !formula.any_version_installed?) &&
          (!OS.mac? || !OS::Mac.version.outdated_release?)
      <<~EOS
        #{formula}: no bottle available!
      EOS
    end

    if message
      message += <<~EOS
        You can try to install from source with:
          brew install --build-from-source #{formula}
        Please note building from source is unsupported. You will encounter build
        failures with some formulae. If you experience any issues please create pull
        requests instead of asking for help on Homebrew's GitHub, Twitter or any other
        official channels.
      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?

    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_attemptedObject

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.



235
236
237
# File 'formula_installer.rb', line 235

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

#check_requirements(req_map) ⇒ Object

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.



524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
# File 'formula_installer.rb', line 524

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.name == "macos" && 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

#cleanvoid

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.



1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
# File 'formula_installer.rb', line 1071

def clean
  ohai "Cleaning" if verbose?
  Cleaner.new(formula).clean
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."
  odebug e, e.backtrace
  Homebrew.failed = true
  @show_summary_heading = true
end

#compute_and_install_dependenciesObject

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.



519
520
521
522
# File 'formula_installer.rb', line 519

def compute_and_install_dependencies
  deps = compute_dependencies
  install_dependencies(deps)
end

#compute_dependencies(use_cache: true) ⇒ Object

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.



503
504
505
506
507
508
509
# File 'formula_installer.rb', line 503

def compute_dependencies(use_cache: true)
  @compute_dependencies = nil unless use_cache
  @compute_dependencies ||= begin
    check_requirements(expand_requirements)
    expand_dependencies
  end
end

#display_options(formula) ⇒ Object

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.



622
623
624
625
626
627
628
629
630
# File 'formula_installer.rb', line 622

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

#downloaderObject

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.



1179
1180
1181
1182
1183
1184
1185
1186
1187
# File 'formula_installer.rb', line 1179

def downloader
  if (bottle_path = formula.local_bottle_path)
    LocalBottleDownloadStrategy.new(bottle_path)
  elsif pour_bottle?
    formula.bottle
  else
    formula
  end
end

#effective_build_options_for(dependent, inherited_options = []) ⇒ Object

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.



614
615
616
617
618
619
620
# File 'formula_installer.rb', line 614

def effective_build_options_for(dependent, inherited_options = [])
  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_dependenciesObject

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.



606
607
608
609
610
611
612
# File 'formula_installer.rb', line 606

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) ⇒ Object

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.



583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
# File 'formula_installer.rb', line 583

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: cache_key) do |dependent, dep|
    inherited_options[dep.name] |= inherited_options_for(dep)
    build = effective_build_options_for(
      dependent,
      inherited_options.fetch(dependent.name, []),
    )

    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?)

    if dep.prune_from_option?(build) || ((dep.build? || dep.test?) && !keep_build_test)
      Dependency.prune
    elsif dep.satisfied?(inherited_options[dep.name])
      Dependency.skip
    end
  end
end

#expand_requirementsObject

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.



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
# File 'formula_installer.rb', line 551

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

  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

#fetchvoid

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.



1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
# File 'formula_installer.rb', line 1159

def fetch
  return if self.class.fetched.include?(formula)

  fetch_dependencies

  return if only_deps?

  if pour_bottle?(output_warning: true)
    formula.fetch_bottle_tab
  elsif formula.core_formula? && Homebrew::EnvConfig.install_from_api?
    odie "Unable to build #{formula.name} from source with HOMEBREW_INSTALL_FROM_API."
  else
    formula.fetch_patches
    formula.resources.each(&:fetch)
  end
  downloader.fetch

  self.class.fetched << formula
end

#fetch_dependenciesvoid

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.



1149
1150
1151
1152
1153
1154
1155
1156
# File 'formula_installer.rb', line 1149

def fetch_dependencies
  return if ignore_deps?

  deps = compute_dependencies
  return if deps.empty?

  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:



657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
# File 'formula_installer.rb', line 657

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.
    ignore_deps:                true,
    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

#finishvoid

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.



766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
# File 'formula_installer.rb', line 766

def finish
  return if only_deps?

  ohai "Finishing up" if verbose?

  keg = Keg.new(formula.prefix)
  link(keg)

  install_service

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

  Homebrew::Install.global_post_install

  if build_bottle?
    ohai "Not running 'post_install' as we're building a bottle"
    puts "You can run it manually using:"
    puts "  brew postinstall #{formula.full_name}"
  else
    post_install
  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 = Tab.for_keg(keg)
  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

  # 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"
    ENV["GIT_SSL_CAPATH"] = formula.pkgetc
  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"
    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:



1060
1061
1062
1063
1064
1065
1066
1067
1068
# File 'formula_installer.rb', line 1060

def fix_dynamic_linkage(keg)
  keg.fix_dynamic_linkage
rescue Exception => e # rubocop:disable Lint/RescueException
  ofail "Failed to fix install linkage"
  puts "The formula built, but you may encounter issues using it or linking other"
  puts "formulae against it."
  odebug e, e.backtrace
  @show_summary_heading = true
end

#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)


134
135
136
# File 'formula_installer.rb', line 134

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:



633
634
635
636
637
638
639
640
# File 'formula_installer.rb', line 633

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

#installvoid

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:



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
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
# File 'formula_installer.rb', line 366

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 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 formula.tap&.installed? && !formula.tap&.private?
    action = "#{formula.full_name} #{options}".strip
    Utils::Analytics.report_event("install", action)

    Utils::Analytics.report_event("install_on_request", action) if installed_on_request?
  end

  self.class.attempted << formula

  if pour_bottle?
    begin
      pour
    rescue Exception # rubocop:disable Lint/RescueException
      # any exceptions must leave us with nothing installed
      ignore_interrupts do
        begin
          formula.prefix.rmtree 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 = Tab.for_keg(keg)
    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)


182
183
184
185
186
187
188
189
190
# File 'formula_installer.rb', line 182

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:



643
644
645
646
647
648
649
650
651
652
653
654
# File 'formula_installer.rb', line 643

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.method(:identifier)).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:



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
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
734
735
736
737
738
739
740
741
742
743
744
745
746
# File 'formula_installer.rb', line 681

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 = Tab.for_keg(linked_keg)
    keg_had_linked_keg = true
    keg_was_linked = linked_keg.linked?
    linked_keg.unlink
  end

  if df.latest_version_installed?
    installed_keg = Keg.new(df.prefix)
    tab ||= Tab.for_keg(installed_keg)
    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

  fi = FormulaInstaller.new(
    df,
    **{
      options:                    options,
      link_keg:                   keg_had_linked_keg ? keg_was_linked : nil,
      installed_as_dependency:    true,
      installed_on_request:       df.any_version_installed? && tab.present? && tab.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
rescue Exception => e # rubocop:disable Lint/RescueException
  ignore_interrupts do
    tmp_keg.rename(installed_keg) 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 { tmp_keg.rmtree if tmp_keg&.directory? }
end

#install_fetch_depsvoid

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.



341
342
343
344
345
346
347
348
349
350
351
# File 'formula_installer.rb', line 341

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.tags == [:build, :test]

    fetch_dependencies
    install_dependency(dep, options)
    true
  end
end

#install_servicevoid

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.



1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
# File 'formula_installer.rb', line 1023

def install_service
  if formula.service? && formula.plist
    ofail "Formula specified both service and plist"
    return
  end

  if formula.service?
    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
  end

  service = if formula.service?
    formula.service.to_plist
  elsif formula.plist
    formula.plist
  end

  return unless service

  plist_path = formula.plist_path
  plist_path.atomic_write(service)
  plist_path.chmod 0644
  log = formula.var/"log"
  log.mkpath if service.include? log.to_s
rescue Exception => e # rubocop:disable Lint/RescueException
  ofail "Failed to install service files"
  odebug e, e.backtrace
end

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:



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
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
# File 'formula_installer.rb', line 936

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).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
  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
    puts e.backtrace if debug?
    @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

#post_installvoid

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.



1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
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
# File 'formula_installer.rb', line 1083

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

  # Use the formula from the keg if:
  # * Installing from a local bottle, or
  # * The formula doesn't exist in the tap (or the tap isn't installed), or
  # * 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 old bottles), use
  # the formula from the tap.
  formula_path = begin
    keg_formula_path = formula.opt_prefix/".brew/#{formula.name}.rb"
    tap_formula_path = formula.path
    keg_formula = Formulary.factory(keg_formula_path)
    tap_formula = Formulary.factory(tap_formula_path) if tap_formula_path.exist?
    other_version_installed = (keg_formula.pkg_version != tap_formula&.pkg_version)

    if formula.local_bottle_path.present? ||
       !tap_formula_path.exist? ||
       other_version_installed
      keg_formula_path
    else
      tap_formula_path
    end
  rescue FormulaUnavailableError, FormulaUnreadableError
    tap_formula_path
  end

  args << formula_path

  Utils.safe_fork do
    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)
      Keg::KEG_LINK_DIRECTORIES.each do |dir|
        sandbox.allow_write_path "#{HOMEBREW_PREFIX}/#{dir}"
      end
      sandbox.exec(*args)
    else
      exec(*args)
    end
  end
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}"
  odebug e, e.backtrace, always_display: Homebrew::EnvConfig.developer?
  Homebrew.failed = true
  @show_summary_heading = true
end

#pourvoid

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.



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
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
# File 'formula_installer.rb', line 1190

def pour
  HOMEBREW_CELLAR.cd do
    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_json
  tab.used_options = []
  tab.unused_options = []
  tab.built_as_bottle = true
  tab.poured_from_bottle = true
  tab.loaded_from_api = formula.class.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"] = 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: 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)


144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
# File 'formula_installer.rb', line 144

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.to_sym)
  return false if bottle.nil?

  unless bottle.compatible_locations?
    if output_warning
      prefix = Pathname(bottle.cellar).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

#preludevoid

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.



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
# File 'formula_installer.rb', line 193

def prelude
  type, reason = DeprecateDisable.deprecate_disable_info formula
  if type.present?
    case type
    when :deprecated
      if reason.present?
        opoo "#{formula.full_name} has been deprecated because it #{reason}!"
      else
        opoo "#{formula.full_name} has been deprecated!"
      end
    when :disabled
      if reason.present?
        raise CannotInstallFormulaError, "#{formula.full_name} has been disabled because it #{reason}!"
      end

      raise CannotInstallFormulaError, "#{formula.full_name} has been disabled!"
    end
  end

  Tab.clear_cache
  verify_deps_exist unless ignore_deps?
  forbidden_license_check

  check_install_sanity
  install_fetch_deps unless ignore_deps?
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:



1234
1235
1236
1237
1238
1239
# File 'formula_installer.rb', line 1234

def problem_if_output(output)
  return unless output

  opoo output
  @show_summary_heading = true
end

#runtime_requirements(formula) ⇒ Object

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.



543
544
545
546
547
548
549
# File 'formula_installer.rb', line 543

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_optionsArray<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:



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
# File 'formula_installer.rb', line 845

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

#summaryString

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:



832
833
834
835
836
837
838
# File 'formula_installer.rb', line 832

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) ⇒ Object

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.



511
512
513
514
515
516
517
# File 'formula_installer.rb', line 511

def unbottled_dependencies(deps)
  deps.map(&:first).map(&:to_formula).reject do |dep_f|
    next false unless dep_f.pour_bottle?

    dep_f.bottled?
  end
end

#verify_deps_existvoid

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.



221
222
223
224
225
226
227
228
229
230
231
232
233
# File 'formula_installer.rb', line 221

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

    e.tap.install
    retry
  end
rescue FormulaUnavailableError => e
  e.dependent = formula.full_name
  raise
end